Add citadel metricset for Istio Metricbeat module #15990
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| //// | ||
| This file is generated! See scripts/mage/docs_collector.go | ||
| //// | ||
|
|
||
| [[metricbeat-metricset-istio-citadel]] | ||
| === istio citadel metricset | ||
|
|
||
| beta[] | ||
|
|
||
| include::../../../../x-pack/metricbeat/module/istio/citadel/_meta/docs.asciidoc[] | ||
|
|
||
|
|
||
| ==== Fields | ||
|
|
||
| For a description of each field in the metricset, see the | ||
| <<exported-fields-istio,exported fields>> section. | ||
|
|
||
| Here is an example document generated by this metricset: | ||
|
|
||
| [source,json] | ||
| ---- | ||
| include::../../../../x-pack/metricbeat/module/istio/citadel/_meta/data.json[] | ||
| ---- |
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| { | ||
| "@timestamp": "2019-03-01T08:05:34.853Z", | ||
| "event": { | ||
| "dataset": "istio.citadel", | ||
| "duration": 115000, | ||
| "module": "istio" | ||
| }, | ||
| "istio": { | ||
| "citadel": { | ||
| "secret_controller_svc_acc_created_cert_count": 58, | ||
| "server_root_cert_expiry_timestamp": 1894287345 | ||
| } | ||
| }, | ||
| "metricset": { | ||
| "name": "citadel", | ||
| "period": 10000 | ||
| }, | ||
| "service": { | ||
| "address": "127.0.0.1:55555", | ||
| "type": "istio" | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| This is the citadel metricset of the module istio. This metricset collects Citadel-specific metrics. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| - name: citadel | ||
| type: group | ||
| description: > | ||
| Contains statistics related to the Istio Citadel service | ||
| release: beta | ||
| fields: | ||
| - name: grpc.method | ||
| type: keyword | ||
| description: > | ||
| The grpc method | ||
| - name: grpc.service | ||
| type: keyword | ||
| description: > | ||
| The grpc service | ||
| - name: grpc.type | ||
| type: keyword | ||
| description: > | ||
| The type of the respective grpc service | ||
|
|
||
| - name: secret_controller_svc_acc_created_cert_count | ||
| type: long | ||
| description: > | ||
| The number of certificates created due to service account creation. | ||
| - name: server_root_cert_expiry_timestamp | ||
|
There was a problem hiding this comment. I'd call it There was a problem hiding this comment. Thanks for suggesting. Will change it. |
||
| type: float | ||
| description: > | ||
| The unix timestamp, in seconds, when Citadel root cert will expire. We set it to negative in case of internal error. | ||
| - name: grpc.server.handled | ||
| type: long | ||
| description: > | ||
| Total number of RPCs completed on the server, regardless of success or failure. | ||
| - name: grpc.server.msg.received | ||
| type: long | ||
| description: > | ||
| Total number of RPC stream messages received on the server. | ||
| - name: grpc.server.msg.sent | ||
| type: long | ||
| description: > | ||
| Total number of gRPC stream messages sent by the server. | ||
| - name: grpc.server.started | ||
| type: long | ||
| description: > | ||
| Total number of RPCs started on the server. | ||
|
|
||
| - name: grpc.server.handling.latency.ms.bucket.* | ||
|
There was a problem hiding this comment. 2 things here:
There was a problem hiding this comment. This is common pattern so far for this kind of Metrics (Prometheus histograms). See There was a problem hiding this comment. Great, thank you for explaining :) |
||
| type: object | ||
| object_type: long | ||
| description: > | ||
| The response latency (milliseconds) of gRPC that had been application-level handled by the server. | ||
| - name: grpc.server.handling.latency.ms.sum | ||
|
There was a problem hiding this comment. Unit at the end :) There was a problem hiding this comment. same as above this is a prometheus spesific concern. |
||
| type: long | ||
| format: duration | ||
| description: > | ||
| The response latency of gRPC, sum of latencies in milliseconds | ||
| - name: grpc.server.handling.latency.ms.count | ||
|
There was a problem hiding this comment. same as above this is a prometheus spesific concern. |
||
| type: long | ||
| description: > | ||
| The response latency of gRPC, number of metrics | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| type: http | ||
| url: "/metrics" | ||
| suffix: plain |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This must be
secret_controller_svc_acc_created_cert.countto follow naming conventionsThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for mentioning. Will change it.