Skip to content

Commit

Permalink
Added warning about otel format
Browse files Browse the repository at this point in the history
  • Loading branch information
ntotten committed Mar 11, 2025
1 parent a196110 commit 7d385cc
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
12 changes: 10 additions & 2 deletions docs/articles/metrics-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,16 @@ tags since those are counted as separate metrics. This
[article by DataDog](https://www.datadoghq.com/blog/the-power-of-tagged-metrics/)
has some good guidelines.

As of October 2023, we're in the process of becoming an official integration
with DataDog, which would reduce the way some of our metrics are counted.
:::warning{title="Metrics Aggregation"}

Your Zuplo API can be deployed to many edge locations. Each location will send
metrics to DataDog independantly. For low volume APIs this may be okay, but
typically you will want to aggregate metrics before sending to DataDog. You can
use a tool like the
[OpenTelemetry Collector](https://opentelemetry.io/docs/collector/) for the
aggregation.

:::

```ts
import {
Expand Down
10 changes: 10 additions & 0 deletions docs/articles/opentelemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,16 @@ Adding OpenTelemetry tracing to your Zuplo API is done by adding the
For most providers you will set values for `exporter.url` and
`exporter.headers`. It's common for providers to use a header for authorization.

:::warning{title="OpenTelemetry Protocol"}

The Zuplo OpenTelemetry plugin only supports sending data in JSON format. Not
all OpenTelemetry services support the JSON format. If you are using a service
that does not support JSON, you will need to use a tool like the
[OpenTelemetry Collector](https://opentelemetry.io/docs/collector/) that can
convert the JSON format to the format required by your service.

:::

```ts title="zuplo.runtime.ts"
import { OpenTelemetryPlugin } from "@zuplo/otel";
import { RuntimeExtensions, environment } from "@zuplo/runtime";
Expand Down

0 comments on commit 7d385cc

Please sign in to comment.