diff --git a/docs/monitors/collectd-kong.md b/docs/monitors/collectd-kong.md index 1a7475bd32..2f14368c12 100644 --- a/docs/monitors/collectd-kong.md +++ b/docs/monitors/collectd-kong.md @@ -54,7 +54,7 @@ This plugin requires: | Software | Version | |-------------------|----------------| -| Kong | 0.11.2+ | +| Kong Community Edition (CE) | 0.11.2+ | | Configured [kong-plugin-signalfx](https://github.com/signalfx/kong-plugin-signalfx) | 0.0.1+ | diff --git a/pkg/monitors/collectd/kong/metadata.yaml b/pkg/monitors/collectd/kong/metadata.yaml index b4fb35b6eb..580471cf92 100644 --- a/pkg/monitors/collectd/kong/metadata.yaml +++ b/pkg/monitors/collectd/kong/metadata.yaml @@ -45,7 +45,7 @@ monitors: | Software | Version | |-------------------|----------------| - | Kong | 0.11.2+ | + | Kong Community Edition (CE) | 0.11.2+ | | Configured [kong-plugin-signalfx](https://github.com/signalfx/kong-plugin-signalfx) | 0.0.1+ | diff --git a/selfdescribe.json b/selfdescribe.json index 7f8c0a8786..0578e2a5bd 100644 --- a/selfdescribe.json +++ b/selfdescribe.json @@ -13901,7 +13901,7 @@ "sendUnknown": false, "noneIncluded": false, "dimensions": null, - "doc": "Monitors a Kong instance using\n[collectd-kong](https://github.com/signalfx/collectd-kong). The Smart\nAgent includes collectd and this plugin as part of the standard\ninstallation, so no additional installation is required once you have the\nSmart Agent.\n\nThe SignalFx Kong collectd plugin provides users with the ability to gather\nand report their service traffic metrics with collectd, in tandem with\n[kong-plugin-signalfx](https://github.com/signalfx/kong-plugin-signalfx).\n\nThis plugin emits metrics for configurable request/response lifecycle groups including:\n\n* Counters for response counts\n* Counters for cumulative response and request sizes\n* Counters for cumulative request, upstream, and Kong latencies\n\nThese request/response lifecycle groups can be optionally partitioned by tunable levels of granularity by:\n\n* API or Service Name/ID\n* Route ID\n* Request HTTP Method\n* Response HTTP Status Code\n\nIn addition to these groups, system-wide connection stats can be provided, including:\n\n* A counter for total fielded requests\n* Gauges for active connections and their various states\n* A gauge for database connectivity\n\nThe `metrics` field below is populated with a set of metrics that are\ndescribed at https://github.com/signalfx/collectd-kong/blob/master/README.md.\n\n\u003c!--- SETUP ---\u003e\n### Install Kong Lua Plugin\n\nPlease download and install this Lua module on all Kong servers by\nfollowing [these instructions](https://github.com/signalfx/kong-plugin-signalfx/blob/master/README.md).\n\n### REQUIREMENTS AND DEPENDENCIES\n\nThis plugin requires:\n\n| Software | Version |\n|-------------------|----------------|\n| Kong | 0.11.2+ |\n| Configured [kong-plugin-signalfx](https://github.com/signalfx/kong-plugin-signalfx) | 0.0.1+ |\n\n\n\u003c!--- SETUP ---\u003e\n## Example Config\n#\nSample YAML configuration:\n\n```yaml\nmonitors:\n - type: collectd/kong\n host: 127.0.0.1\n port: 8001\n metrics:\n - metric: request_latency\n report: true\n - metric: connections_accepted\n report: false\n```\n\nSample YAML configuration with custom /signalfx route and filter lists\n\n```yaml\nmonitors:\n - type: collectd/kong\n host: 127.0.0.1\n port: 8443\n url: https://127.0.0.1:8443/routed_signalfx\n authHeader:\n header: Authorization\n value: HeaderValue\n metrics:\n - metric: request_latency\n report: true\n reportStatusCodeGroups: true\n statusCodes:\n - 202\n - 403\n - 405\n - 419\n - \"5*\"\n serviceNamesBlacklist:\n - \"*SomeService*\"\n```\n", + "doc": "Monitors a Kong instance using\n[collectd-kong](https://github.com/signalfx/collectd-kong). The Smart\nAgent includes collectd and this plugin as part of the standard\ninstallation, so no additional installation is required once you have the\nSmart Agent.\n\nThe SignalFx Kong collectd plugin provides users with the ability to gather\nand report their service traffic metrics with collectd, in tandem with\n[kong-plugin-signalfx](https://github.com/signalfx/kong-plugin-signalfx).\n\nThis plugin emits metrics for configurable request/response lifecycle groups including:\n\n* Counters for response counts\n* Counters for cumulative response and request sizes\n* Counters for cumulative request, upstream, and Kong latencies\n\nThese request/response lifecycle groups can be optionally partitioned by tunable levels of granularity by:\n\n* API or Service Name/ID\n* Route ID\n* Request HTTP Method\n* Response HTTP Status Code\n\nIn addition to these groups, system-wide connection stats can be provided, including:\n\n* A counter for total fielded requests\n* Gauges for active connections and their various states\n* A gauge for database connectivity\n\nThe `metrics` field below is populated with a set of metrics that are\ndescribed at https://github.com/signalfx/collectd-kong/blob/master/README.md.\n\n\u003c!--- SETUP ---\u003e\n### Install Kong Lua Plugin\n\nPlease download and install this Lua module on all Kong servers by\nfollowing [these instructions](https://github.com/signalfx/kong-plugin-signalfx/blob/master/README.md).\n\n### REQUIREMENTS AND DEPENDENCIES\n\nThis plugin requires:\n\n| Software | Version |\n|-------------------|----------------|\n| Kong Community Edition (CE) | 0.11.2+ |\n| Configured [kong-plugin-signalfx](https://github.com/signalfx/kong-plugin-signalfx) | 0.0.1+ |\n\n\n\u003c!--- SETUP ---\u003e\n## Example Config\n#\nSample YAML configuration:\n\n```yaml\nmonitors:\n - type: collectd/kong\n host: 127.0.0.1\n port: 8001\n metrics:\n - metric: request_latency\n report: true\n - metric: connections_accepted\n report: false\n```\n\nSample YAML configuration with custom /signalfx route and filter lists\n\n```yaml\nmonitors:\n - type: collectd/kong\n host: 127.0.0.1\n port: 8443\n url: https://127.0.0.1:8443/routed_signalfx\n authHeader:\n header: Authorization\n value: HeaderValue\n metrics:\n - metric: request_latency\n report: true\n reportStatusCodeGroups: true\n statusCodes:\n - 202\n - 403\n - 405\n - 419\n - \"5*\"\n serviceNamesBlacklist:\n - \"*SomeService*\"\n```\n", "groups": { "": { "description": "",