SpringCloud/spring-cloud-config
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

WIP

Browse Source
This commit is contained in:
Marcin Grzejszczak
2023-09-08 16:59:24 +02:00
committed by spencergibb
parent b5fa7dcac0
commit 10a5f611c0
22 changed files with 435 additions and 158 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/modules/ROOT/partials/_conventions.adoc Normal file
View File

@@ -0,0 +1,10 @@
[[observability-conventions]]
=== Observability - Conventions
Below you can find a list of all `GlobalObservationConvention` and `ObservationConvention` declared by this project.
.ObservationConvention implementations
|===
|ObservationConvention Class Name | Applicable ObservationContext Class Name
|`org.springframework.cloud.config.server.environment.ObservationEnvironmentRepositoryObservationConvention`|`ObservationEnvironmentRepositoryContext`
|===

41
docs/modules/ROOT/partials/_metrics.adoc Normal file
View File

@@ -0,0 +1,41 @@
[[observability-metrics]]
=== Observability - Metrics
Below you can find a list of all metrics declared by this project.
[[observability-metrics-environment-repository]]
==== Environment Repository
____
Observation created around an EnvironmentRepository.
____
**Metric name** `spring.cloud.config.environment.find` (defined by convention class `org.springframework.cloud.config.server.environment.ObservationEnvironmentRepositoryObservationConvention`). **Type** `timer`.
**Metric name** `spring.cloud.config.environment.find.active` (defined by convention class `org.springframework.cloud.config.server.environment.ObservationEnvironmentRepositoryObservationConvention`). **Type** `long task timer`.
IMPORTANT: KeyValues that are added after starting the Observation might be missing from the *.active metrics.
IMPORTANT: Micrometer internally uses `nanoseconds` for the baseunit. However, each backend determines the actual baseunit. (i.e. Prometheus uses seconds)
Fully qualified name of the enclosing class `org.springframework.cloud.config.server.environment.DocumentedConfigObservation`.
IMPORTANT: All tags must be prefixed with `spring.cloud.config.environment` prefix!
.Low cardinality Keys
[cols="a,a"]
|===
|Name | Description
|`spring.cloud.config.environment.application` _(required)_|Application name for which properties are being queried for.
|`spring.cloud.config.environment.class` _(required)_|Implementation of the EnvironmentRepository.
|`spring.cloud.config.environment.label` _(required)_|Label for which properties are being queried for.
|`spring.cloud.config.environment.profile` _(required)_|Application name for which properties are being queried for.
|===

28
docs/modules/ROOT/partials/_spans.adoc Normal file
View File

@@ -0,0 +1,28 @@
[[observability-spans]]
=== Observability - Spans
Below you can find a list of all spans declared by this project.
[[observability-spans-environment-repository]]
==== Environment Repository Span
> Observation created around an EnvironmentRepository.
**Span name** `spring.cloud.config.environment.find` (defined by convention class `org.springframework.cloud.config.server.environment.ObservationEnvironmentRepositoryObservationConvention`).
Fully qualified name of the enclosing class `org.springframework.cloud.config.server.environment.DocumentedConfigObservation`.
IMPORTANT: All tags must be prefixed with `spring.cloud.config.environment` prefix!
.Tag Keys
|===
|Name | Description
|`spring.cloud.config.environment.application` _(required)_|Application name for which properties are being queried for.
|`spring.cloud.config.environment.class` _(required)_|Implementation of the EnvironmentRepository.
|`spring.cloud.config.environment.label` _(required)_|Label for which properties are being queried for.
|`spring.cloud.config.environment.profile` _(required)_|Application name for which properties are being queried for.
|===