Enable Solace Loggingv3.12+
Set up the Solace logging plugin to send logs to a Solace message broker.
Prerequisites
- Solace installed and running
Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: solace-log
config:
session:
host: tcp://192.168.88.20:55555
vpn_name: default
authentication:
scheme: BASIC
username: admin
password: admin
message:
destinations:
- name: test
type: QUEUE
delivery_mode: PERSISTENT
custom_fields_by_lua:
broker: return "solace"
Make the following request:
curl -i -X POST http://localhost:8001/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "solace-log",
"config": {
"session": {
"host": "tcp://192.168.88.20:55555",
"vpn_name": "default",
"authentication": {
"scheme": "BASIC",
"username": "admin",
"password": "admin"
}
},
"message": {
"destinations": [
{
"name": "test",
"type": "QUEUE"
}
],
"delivery_mode": "PERSISTENT",
"custom_fields_by_lua": {
"broker": "return \"solace\""
}
}
},
"tags": []
}
'
Make the following request:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/plugins/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"name": "solace-log",
"config": {
"session": {
"host": "tcp://192.168.88.20:55555",
"vpn_name": "default",
"authentication": {
"scheme": "BASIC",
"username": "admin",
"password": "admin"
}
},
"message": {
"destinations": [
{
"name": "test",
"type": "QUEUE"
}
],
"delivery_mode": "PERSISTENT",
"custom_fields_by_lua": {
"broker": "return \"solace\""
}
}
},
"tags": []
}
'
Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
controlPlaneId: Theidof the control plane.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
name: solace-log
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
labels:
global: 'true'
config:
session:
host: tcp://192.168.88.20:55555
vpn_name: default
authentication:
scheme: BASIC
username: admin
password: admin
message:
destinations:
- name: test
type: QUEUE
delivery_mode: PERSISTENT
custom_fields_by_lua:
broker: return 'solace'
plugin: solace-log
" | kubectl apply -f -
Prerequisite: Configure your Personal Access Token
terraform {
required_providers {
konnect = {
source = "kong/konnect"
}
}
}
provider "konnect" {
personal_access_token = "$KONNECT_TOKEN"
server_url = "https://us.api.konghq.com/"
}
Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_solace_log" "my_solace_log" {
enabled = true
config = {
session = {
host = "tcp://192.168.88.20:55555"
vpn_name = "default"
authentication = {
scheme = "BASIC"
username = "admin"
password = "admin"
}
}
message = {
destinations = [
{
name = "test"
type = "QUEUE"
} ]
delivery_mode = "PERSISTENT"
custom_fields_by_lua = {
broker = "return \"solace\""
}
}
}
tags = []
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}
Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: solace-log
service: serviceName|Id
config:
session:
host: tcp://192.168.88.20:55555
vpn_name: default
authentication:
scheme: BASIC
username: admin
password: admin
message:
destinations:
- name: test
type: QUEUE
delivery_mode: PERSISTENT
custom_fields_by_lua:
broker: return "solace"
Make sure to replace the following placeholders with your own values:
-
serviceName|Id: Theidornameof the service the plugin configuration will target.
Make the following request:
curl -i -X POST http://localhost:8001/services/{serviceName|Id}/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "solace-log",
"config": {
"session": {
"host": "tcp://192.168.88.20:55555",
"vpn_name": "default",
"authentication": {
"scheme": "BASIC",
"username": "admin",
"password": "admin"
}
},
"message": {
"destinations": [
{
"name": "test",
"type": "QUEUE"
}
],
"delivery_mode": "PERSISTENT",
"custom_fields_by_lua": {
"broker": "return \"solace\""
}
}
},
"tags": []
}
'
Make sure to replace the following placeholders with your own values:
-
serviceName|Id: Theidornameof the service the plugin configuration will target.
Make the following request:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/services/{serviceId}/plugins/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"name": "solace-log",
"config": {
"session": {
"host": "tcp://192.168.88.20:55555",
"vpn_name": "default",
"authentication": {
"scheme": "BASIC",
"username": "admin",
"password": "admin"
}
},
"message": {
"destinations": [
{
"name": "test",
"type": "QUEUE"
}
],
"delivery_mode": "PERSISTENT",
"custom_fields_by_lua": {
"broker": "return \"solace\""
}
}
},
"tags": []
}
'
Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
controlPlaneId: Theidof the control plane. -
serviceId: Theidof the service the plugin configuration will target.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: solace-log
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
config:
session:
host: tcp://192.168.88.20:55555
vpn_name: default
authentication:
scheme: BASIC
username: admin
password: admin
message:
destinations:
- name: test
type: QUEUE
delivery_mode: PERSISTENT
custom_fields_by_lua:
broker: return 'solace'
plugin: solace-log
" | kubectl apply -f -
Next, apply the KongPlugin resource by annotating the service resource:
kubectl annotate -n kong service SERVICE_NAME konghq.com/plugins=solace-log
Prerequisite: Configure your Personal Access Token
terraform {
required_providers {
konnect = {
source = "kong/konnect"
}
}
}
provider "konnect" {
personal_access_token = "$KONNECT_TOKEN"
server_url = "https://us.api.konghq.com/"
}
Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_solace_log" "my_solace_log" {
enabled = true
config = {
session = {
host = "tcp://192.168.88.20:55555"
vpn_name = "default"
authentication = {
scheme = "BASIC"
username = "admin"
password = "admin"
}
}
message = {
destinations = [
{
name = "test"
type = "QUEUE"
} ]
delivery_mode = "PERSISTENT"
custom_fields_by_lua = {
broker = "return \"solace\""
}
}
}
tags = []
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
service = {
id = konnect_gateway_service.my_service.id
}
}
Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: solace-log
route: routeName|Id
config:
session:
host: tcp://192.168.88.20:55555
vpn_name: default
authentication:
scheme: BASIC
username: admin
password: admin
message:
destinations:
- name: test
type: QUEUE
delivery_mode: PERSISTENT
custom_fields_by_lua:
broker: return "solace"
Make sure to replace the following placeholders with your own values:
-
routeName|Id: Theidornameof the route the plugin configuration will target.
Make the following request:
curl -i -X POST http://localhost:8001/routes/{routeName|Id}/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "solace-log",
"config": {
"session": {
"host": "tcp://192.168.88.20:55555",
"vpn_name": "default",
"authentication": {
"scheme": "BASIC",
"username": "admin",
"password": "admin"
}
},
"message": {
"destinations": [
{
"name": "test",
"type": "QUEUE"
}
],
"delivery_mode": "PERSISTENT",
"custom_fields_by_lua": {
"broker": "return \"solace\""
}
}
},
"tags": []
}
'
Make sure to replace the following placeholders with your own values:
-
routeName|Id: Theidornameof the route the plugin configuration will target.
Make the following request:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/routes/{routeId}/plugins/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"name": "solace-log",
"config": {
"session": {
"host": "tcp://192.168.88.20:55555",
"vpn_name": "default",
"authentication": {
"scheme": "BASIC",
"username": "admin",
"password": "admin"
}
},
"message": {
"destinations": [
{
"name": "test",
"type": "QUEUE"
}
],
"delivery_mode": "PERSISTENT",
"custom_fields_by_lua": {
"broker": "return \"solace\""
}
}
},
"tags": []
}
'
Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
controlPlaneId: Theidof the control plane. -
routeId: Theidof the route the plugin configuration will target.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: solace-log
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
config:
session:
host: tcp://192.168.88.20:55555
vpn_name: default
authentication:
scheme: BASIC
username: admin
password: admin
message:
destinations:
- name: test
type: QUEUE
delivery_mode: PERSISTENT
custom_fields_by_lua:
broker: return 'solace'
plugin: solace-log
" | kubectl apply -f -
Next, apply the KongPlugin resource by annotating the httproute or ingress resource:
kubectl annotate -n kong httproute konghq.com/plugins=solace-log
kubectl annotate -n kong ingress konghq.com/plugins=solace-log
Prerequisite: Configure your Personal Access Token
terraform {
required_providers {
konnect = {
source = "kong/konnect"
}
}
}
provider "konnect" {
personal_access_token = "$KONNECT_TOKEN"
server_url = "https://us.api.konghq.com/"
}
Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_solace_log" "my_solace_log" {
enabled = true
config = {
session = {
host = "tcp://192.168.88.20:55555"
vpn_name = "default"
authentication = {
scheme = "BASIC"
username = "admin"
password = "admin"
}
}
message = {
destinations = [
{
name = "test"
type = "QUEUE"
} ]
delivery_mode = "PERSISTENT"
custom_fields_by_lua = {
broker = "return \"solace\""
}
}
}
tags = []
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
route = {
id = konnect_gateway_route.my_route.id
}
}