Skip to content

Commit

Permalink
docs: exporter metrics example
Browse files Browse the repository at this point in the history
  • Loading branch information
EuroLew committed Nov 1, 2024
1 parent 58e42eb commit 365e399
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 2 deletions.
19 changes: 18 additions & 1 deletion docs/self-managed/concepts/exporters.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,24 @@ heavy work during instantiation/configuration.

### Metrics

The exporter is provided with a Micrometer [MeterRegistry](https://docs.micrometer.io/micrometer/reference/concepts/registry.html) in the `Exporter#configure(Context)` method through the configuration. Any metrics to be exported should interact with the registry.
The exporter is provided with a Micrometer [MeterRegistry](https://docs.micrometer.io/micrometer/reference/concepts/registry.html) in the `Exporter#configure(Context)` method through the configuration. Any metrics to be exported should interact with the registry, for example:

```java
public class SomeExporter implements Exporter {
@Override
public void configure(final Context context) {
// ...
registry = context.getMeterRegistry();
// ...
}

public void flush() {
try (final var ignored = Timer.resource(registry, "meter.name")) {
exportBulk();
}
}
}
```

When an exporter is validated, it is only provided with an in-memory register which is then discarded.

Expand Down
19 changes: 18 additions & 1 deletion versioned_docs/version-8.6/self-managed/concepts/exporters.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,24 @@ heavy work during instantiation/configuration.

### Metrics

The exporter is provided with a Micrometer [MeterRegistry](https://docs.micrometer.io/micrometer/reference/concepts/registry.html) in the `Exporter#configure(Context)` method through the configuration. Any metrics to be exported should interact with the registry.
The exporter is provided with a Micrometer [MeterRegistry](https://docs.micrometer.io/micrometer/reference/concepts/registry.html) in the `Exporter#configure(Context)` method through the configuration. Any metrics to be exported should interact with the registry, for example:

```java
public class SomeExporter implements Exporter {
@Override
public void configure(final Context context) {
// ...
registry = context.getMeterRegistry();
// ...
}

public void flush() {
try (final var ignored = Timer.resource(registry, "meter.name")) {
exportBulk();
}
}
}
```

When an exporter is validated, it is only provided with an in-memory register which is then discarded.

Expand Down

0 comments on commit 365e399

Please sign in to comment.