Skip to content

Commit 934921a

Browse files
Apply suggestions from code review
Co-authored-by: Zachary Hu <[email protected]>
1 parent 5dae4e4 commit 934921a

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

app/_kong_plugins/solace-log/index.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ content_type: plugin
66

77
publisher: kong-inc
88
tier: enterprise
9-
description: 'Publish request and response logs to a Solace topic'
9+
description: 'Publish request and response logs to a Solace endpoint or topic'
1010

1111
products:
1212
- gateway
@@ -52,10 +52,10 @@ related_resources:
5252
url: /event-gateway/
5353
---
5454

55-
Publish request and response logs to a [Solace](https://solace.com/) topic.
56-
For more information, see [Understanding Solace topics](https://docs.solace.com/Get-Started/what-are-topics.htm).
55+
Publish request and response logs in `JSON` format to a [Solace](https://solace.com/) endpoint or topic.
56+
For more information, see [Solace Event Messaging Overview](https://docs.solace.com/Messaging/messaging-overview.htm).
5757

58-
Kong also provides Solace plugins for request and response transformations:
58+
Kong also provides plugins for publishing messages to and consuming messages from Solace:
5959
* [Solace Upstream](/plugins/solace-upstream/)
6060
* [Solace Consume](/plugins/solace-consume/)
6161

@@ -65,7 +65,11 @@ Kong also provides Solace plugins for request and response transformations:
6565

6666
## Implementation details
6767

68-
TBA
68+
This plugin leverages the [log PDK](/gateway/pdk/reference/kong.log/) to collect and [customize](#custom-fields-by-lua) log fields.
69+
70+
The prepared log message is sent to Solace broker via the official [Solace C API](https://docs.solace.com/API/Messaging-APIs/C-API/c-api-home.htm). The sending job is executed in a background timer context, such that it would not block the client requests.
71+
72+
If the [custom Lua code](#custom-fields-by-lua) associated with the log fields fails to execute, the relavent fields remain untouched.
6973

7074
## Custom fields by Lua
7175

0 commit comments

Comments
 (0)