open-telemetry
/
opentelemetry-java
mirror of https://github.com/open-telemetry/opentelemetry-java.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix metrics incubator docs (#4567)

This commit is contained in:
jack-berg 2022-06-29 16:24:57 -05:00 committed by GitHub
parent 0860b3884b
commit cb864fd209
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 16 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
sdk-extensions/metric-incubator/README.md
View File

@ -32,20 +32,17 @@ The equivalent view configuration would be:
SdkMeterProvider.builder() SdkMeterProvider.builder()
.registerView( .registerView(
InstrumentSelector.builder() InstrumentSelector.builder()
.setInstrumentName("my-instrument") .setName("my-instrument")
.setInstrumentType(InstrumentType.COUNTER) .setType(InstrumentType.COUNTER)
.setMeterSelector( .setMeterName("my-meter")
MeterSelector.builder() .setMeterVersion("1.0.0")
.setName("my-meter") .setMeterSchemaUrl("http://example.com")
.setVersion("1.0.0")
.setSchemaUrl("http://example.com")
.build())
.build(), .build(),
View.builder() View.builder()
.setName("new-instrument") .setName("new-instrument")
.setDescription("new-description") .setDescription("new-description")
.setAggregation(Aggregation.histogram()) .setAggregation(Aggregation.histogram())
.filterAttributes(key -> new HashSet<>(Arrays.asList("foo", "bar")).contains(key)) .setAttributesFilter(key -> new HashSet<>(Arrays.asList("foo", "bar")).contains(key))
.build()); .build());
``` ```
@ -76,8 +73,8 @@ Notes on usage:
will result in the default from `InstrumentSelector` being used. will result in the default from `InstrumentSelector` being used.
- At least one view field is required, but including all is not required. Any omitted fields will - At least one view field is required, but including all is not required. Any omitted fields will
result in the default from `View` being used. result in the default from `View` being used.
- Advanced selection criteria, like regular expressions, is not yet supported. - Instrument name selection supports the following wildcard characters: `*` matches 0 or more instances of any character; `?` matches exactly one instance of any character. No other advanced selection criteria is supported.
[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-extension-metric-incubator [javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-extension-metric-incubator.svg
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-extension-metric-incubator [javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-extension-metric-incubator

15
sdk-extensions/metric-incubator/src/main/java/io/opentelemetry/sdk/viewconfig/ViewConfig.java
View File

@ -54,20 +54,17 @@ import org.yaml.snakeyaml.Yaml;
* SdkMeterProvider.builder() * SdkMeterProvider.builder()
* .registerView( * .registerView(
* InstrumentSelector.builder() * InstrumentSelector.builder()
* .setInstrumentName("my-instrument") * .setName("my-instrument")
* .setInstrumentType(InstrumentType.COUNTER) * .setType(InstrumentType.COUNTER)
* .setMeterSelector( * .setMeterName("my-meter")
* MeterSelector.builder() * .setMeterVersion("1.0.0")
* .setName("my-meter") * .setMeterSchemaUrl("http://example.com")
* .setVersion("1.0.0")
* .setSchemaUrl("http://example.com")
* .build())
* .build(), * .build(),
* View.builder() * View.builder()
* .setName("new-instrument") * .setName("new-instrument")
* .setDescription("new-description") * .setDescription("new-description")
* .setAggregation(Aggregation.histogram()) * .setAggregation(Aggregation.histogram())
* .filterAttributes(key -> new HashSet<>(Arrays.asList("foo", "bar")).contains(key)) * .setAttributesFilter(key -> new HashSet<>(Arrays.asList("foo", "bar")).contains(key))
* .build()); * .build());
* }</pre> * }</pre>
*/ */