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

Export metrics example #4551

Merged
merged 1 commit into from
Nov 1, 2024
Merged

Export metrics example #4551

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion docs/self-managed/concepts/exporters.md
View file
Open in desktop
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
View file
Open in desktop
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
Loading