[exporter/tanzuobservability] Add metrics to README. #7948
Conversation
keep94
force-pushed
the
readme_changes
branch
from
68f1c0c to
0146ddd
Compare
| @@ -1,21 +1,29 @@ | |||
| # Tanzu Observability (Wavefront) Exporter | |||
|
|
|||
| This exporter supports sending traces to [Tanzu Observability](https://tanzu.vmware.com/observability). | |||
| This exporter supports sending both traces and metrics to [Tanzu Observability](https://tanzu.vmware.com/observability). | |||
|
|
|||
| ## Prerequisites | |||
|
|
|||
| - [Obtain the Tanzu Observability by Wavefront API token.](https://docs.wavefront.com/wavefront_api.html#generating-an-api-token) | |||
| - [Set up and start a Tanzu Observability by Wavefront proxy](https://docs.wavefront.com/proxies_installing.html) and configure it with the API token you obtained. | |||
| - To have the proxy generate [span RED metrics](https://docs.wavefront.com/trace_data_details.html#red-metrics) from trace data, [configure](https://docs.wavefront.com/proxies_configuring.html) the proxy's `customTracingListenerPorts` and use it for the exporter's endpoint. | |||
There was a problem hiding this comment.
I think this needs updating now that we support metrics in addition to traces, and should be simplified. Let's replace the bullet point above with:
- Configure the proxy to receive traces by setting
customTracingListenerPorts=30001. For metrics, the proxy listens on port 2878 by default.
| - Delta histograms get converted to histograms in wavefront | ||
| - Exponential histograms are converted the same way as regular histograms | ||
| - Each summary metric is converted to multiple gauge metrics (one gauge metric for each quantile in the summary). A special "quantile" tag contains a value between 0 and 1 indicating the quantile for which the value belongs. | ||
|
|
||
| ## Tanzu Observability Specific Attributes | ||
|
|
There was a problem hiding this comment.
Let's replace this and the two sub-bullets with:
- Tanzu Observability Spans require two Application Tags:
applicationandservice. If missing, the exporter defaults them toapplication=defaultAppandservice=defaultService.
There was a problem hiding this comment.
Actually, my comment doesn't account for service.name. We'll pair up to figure out the wording.
| @@ -47,13 +55,19 @@ exporters: | |||
| tanzuobservability: | |||
There was a problem hiding this comment.
When Travis and I pair on updating this PR, let's consider promoting the Configuration section towards the top of the README, since that's likely what users care about most to get the exporter running.
|
FYI, this PR now depends on PR #8338 |
| Given a Wavefront proxy at `10.10.10.10`, configured with `customTracingListenerPorts` set to `30001`, the traces endpoint would be `http://10.10.10.10:30001` | ||
| and the metrics endpoint would be `http://10.10.10.10:2878`. | ||
|
|
||
| ### Resource Attributes |
There was a problem hiding this comment.
Let's title this "Resource Attributes on Metrics".
There was a problem hiding this comment.
Let's also move this section below the "Example Configuration" section.
| @@ -78,7 +110,8 @@ exporters: | |||
| endpoint: "http://10.10.10.10:30001" | |||
| metrics: | |||
| endpoint: "http://10.10.10.10:2878" | |||
| resource_attributes: false | |||
| resource_attributes: | |||
| enabled: true | |||
There was a problem hiding this comment.
Let's set this to false in the likely event someone copy and pastes this example when getting started.
| Client programs can send a series of global key-value pairs along with metrics to the | ||
| open telemetry collector. By default, the Tanzu Observability Exporter does not send these, but | ||
| if the resource_attributes stanza is included in the configuration file as it is below, the | ||
| Tanzu Observability Exporter will include sent resource attributes as additional tags in each | ||
| metric. |
There was a problem hiding this comment.
Slight wording and formatting tweaks to this:
Client programs using an OpenTelemetry SDK can be configured to wrap all emitted telemetry (metrics, spans, logs) with a set of global key-value pairs, called resource attributes. By default, the Tanzu Observability Exporter includes resource attributes on spans but excludes them on metrics. To include resource attributes as tags on metrics, configure the resource_attributes stanza per the example above.
| The required configurations are two Wavefront proxy API endpoints: one to receive traces and one to | ||
| receive metrics from the Tanzu Observability Exporter. |
There was a problem hiding this comment.
Let's delete this whole sentence.
|
Once this has been reviewed by code owners and is ready for review by me, let me know. |
|
Hi, this change has become a part of PR #9098 |
Documentation:
Add documentation for the metrics portion of the tanzu observability exporter.