Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

NXDOC-2208: Add GCP metric and trace (stackdriver) #1603

Merged
merged 1 commit into from Nov 17, 2020
Merged

NXDOC-2208: Add GCP metric and trace (stackdriver) #1603

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions assets/nxdoc/next/metrics/stackdriver-metric.png
View file
Open in desktop
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions assets/nxdoc/next/tracing/stackdriver-trace.png
View file
Open in desktop
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 20 additions & 0 deletions src/nxdoc/nuxeo-server/administration/observability/metrics.md
View file
Open in desktop
Expand Up @@ -40,6 +40,7 @@ By default, since Nuxeo 11, we have the following metric reporters:
- Graphite
- Datadog
- Prometheus
- GCP Metrics (previously known as Stackdriver)

It is possible to activate multiple reporters at the same time.

Expand Down Expand Up @@ -84,6 +85,11 @@ that express the work `queue` dimension, the metric name is translated into:
<td>dimensional</td>
<td>dropwizard5_nuxeo_works_global_queue_scheduled_gauge{instance="nuxeo:8888",job="nuxeo",queue="videoConversion"}</td>
</tr>
<tr>
<th>GCP Metrics (Stackdriver)</th>
<td>dimensional</td>
<td>custom.googleapis.com/nuxeo/dropwizard5_nuxeo.works.global.queue.scheduled queue:videoConversion</td>
</tr>
</tbody>
</table>
</div>
Expand Down Expand Up @@ -195,6 +201,20 @@ and suffixed depending on metric types (`_gauge`, `_count` and `_timer`).

![prometheus]({{file name='prometheus-nav.png'}} ?w=650,border=true)

### GCP Metrics (Stackdriver)

You need to provide a valid GCP project identifier.

Configuration:
```
metrics.stackdriver.enabled=true
metrics.stackdriver.gcpProjectId=MY-GCP-PROJECT-ID
```

The metrics will be prefixed by `custom.googleapis.com/nuxeo/dropwizard5_`

![stackdriver]({{file name='stackdriver-metric.png'}} ?w=650,border=true)

## Metrics Filtering

A counter or gauge instrumentation create a single metric,
Expand Down
14 changes: 14 additions & 0 deletions src/nxdoc/nuxeo-server/administration/observability/tracing.md
View file
Open in desktop
Expand Up @@ -68,6 +68,20 @@ tracing.datadog.enabled=true
tracing.datadog.url=http://localhost:8126/v0.3/traces
```

### GCP Trace (Stackdriver)

You need to provide a valid GCP project identifier.

```
metrics.enabled=true

tracing.stackdriver.enabled=true
tracing.stackdriver.timeout=30s
tracing.stackdriver.gcpProjectId=MY-GCP-PROJECT-ID
```

![stackdriver]({{file name='stackdriver-trace.png'}} ?w=650,border=true)

## Configuring What is Traced

Which request is traced can be determined by sampling probability using the option `tracing.sampler.probability`.
Expand Down