docs: update "Metrics" Plugins #7188
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Navendu Pottekkat <navendupottekkat@gmail.com>
Signed-off-by: Navendu Pottekkat <navendupottekkat@gmail.com>
…ub.com/navendu-pottekkat/apisix into docs/plugin-observability-metrics/6734
|
// @hf400159 @kwanhur @avinal @yzeng25 @juzhiyuan Please review when you are available. |
avinal
reviewed
Jun 3, 2022
docs/en/latest/plugins/datadog.md
Outdated
| @@ -23,62 +29,93 @@ title: datadog | |||
|
|
|||
| ## Description | |||
|
|
|||
| `datadog` is a monitoring plugin built into Apache APISIX for seamless integration with [Datadog](https://www.datadoghq.com/), one of the most used monitoring and observability platform for cloud applications. If enabled, this plugin supports multiple powerful types of metrics capture for every request and response cycle that essentially reflects the behaviour and health of the system. | |||
| The `datadog` monitoring Plugin if for seamless integration of APISIX with [Datadog](https://www.datadoghq.com/), one of the most used monitoring and observability platform for cloud applications. | |||
There was a problem hiding this comment.
Suggested change
| The `datadog` monitoring Plugin if for seamless integration of APISIX with [Datadog](https://www.datadoghq.com/), one of the most used monitoring and observability platform for cloud applications. | |
| The `datadog` monitoring Plugin is for seamless integration of APISIX with [Datadog](https://www.datadoghq.com/), one of the most used monitoring and observability platform for cloud applications. |
avinal
reviewed
Jun 3, 2022
docs/en/latest/plugins/datadog.md
Outdated
|
|
||
| For more info on Batch-Processor in Apache APISIX please refer. | ||
| [Batch-Processor](../batch-processor.md) | ||
| DogStatsD is basically an implementation of the StatsD protocol which collects the custom metrics for Apache APISIX agent, aggregates it into a single data point, and sends it to the configured Datadog server. |
There was a problem hiding this comment.
Suggested change
| DogStatsD is basically an implementation of the StatsD protocol which collects the custom metrics for Apache APISIX agent, aggregates it into a single data point, and sends it to the configured Datadog server. | |
| DogStatsD implements the StatsD protocol which collects the custom metrics for the Apache APISIX agent, aggregates them into a single data point, and sends it to the configured Datadog server. |
avinal
reviewed
Jun 3, 2022
docs/en/latest/plugins/datadog.md
Outdated
|
|
||
| Apache APISIX agent, for every request response cycle, export the following metrics to DogStatsD server if the datadog plugin is enabled: | ||
| When the `datadog` Plugin is enabled, APISIX agent exports the following metrics to the DogStatsD server for each request/response cycle: |
There was a problem hiding this comment.
Suggested change
| When the `datadog` Plugin is enabled, APISIX agent exports the following metrics to the DogStatsD server for each request/response cycle: | |
| When the `datadog` Plugin is enabled, the APISIX agent exports the following metrics to the DogStatsD server for each request/response cycle: |
avinal
reviewed
Jun 3, 2022
Comment on lines
+103
to
+108
| - `route_name`: Name specified in the Route schema definition. If not present or if the attribute `prefer_name` is set to false, falls back to the Route ID. | ||
| - `service_name`: If a Route has been created with an abstracted Service, the Service name/ID based on the attribute `prefer_name`. | ||
| - `consumer`: If the Route is linked to a Consumer, the username will be added as a tag. | ||
| - `balancer_ip`: IP address of the Upstream balancer that processed the current request. | ||
| - `response_status`: HTTP response status code. | ||
| - `scheme`: Request scheme such as HTTP, gRPC, and gRPCs. |
There was a problem hiding this comment.
I guess it would be nice to put these into a tabular form. What do you think?
There was a problem hiding this comment.
I think we are following this structure without tables in some other places as well. So, we can keep it as it is now.
|
IIRC we agreed upon using |
guitu168
reviewed
Jun 6, 2022
docs/en/latest/plugins/datadog.md
Outdated
| | prefer_name | boolean | optional | true | true/false | If set to `false`, would use route/service id instead of name(default) with metric tags. | | ||
| | Name | Type | Required | Default | Valid values | Description | | ||
| | ----------- | ------- | -------- | ------- | ------------ | ---------------------------------------------------------------------------------------- | | ||
| | prefer_name | boolean | False | true | true/false | When set to `false`, uses Route/Service ID instead of name (default) with metric tags. | |
There was a problem hiding this comment.
Suggested change
| | prefer_name | boolean | False | true | true/false | When set to `false`, uses Route/Service ID instead of name (default) with metric tags. | | |
| | prefer_name | boolean | False | true | [true, false] | When set to `false`, uses Route/Service ID instead of name (default) with metric tags. | |
We are using "shell" in a lot of places and it seems to be working without issues right now. So, it was decided to keep using shell. |
Signed-off-by: Navendu Pottekkat <navendupottekkat@gmail.com>
|
Ready for another round of review. |
Signed-off-by: Navendu Pottekkat <navendupottekkat@gmail.com>
…ub.com/navendu-pottekkat/apisix into docs/plugin-observability-metrics/6734
juzhiyuan
approved these changes
Jun 16, 2022
yzeng25
approved these changes
Jun 17, 2022
5 tasks
spacewander
pushed a commit
that referenced
this pull request
Jun 30, 2022
Liu-Junlin
pushed a commit
to Liu-Junlin/apisix
that referenced
this pull request
Nov 4, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Navendu Pottekkat navendupottekkat@gmail.com
Description
Updates the documentation of the "Observability/Metrics" Plugins.
Child PR of #6734