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

View File

@ -87,7 +87,7 @@ Finally, update the [website docs][] to refer to the newly released version.
The following credentials are required for publishing (and automatically set in Github Actions):
* `GPG_PRIVATE_KEY` and `GPG_PASSWORD`: GPG private key and password for signing.
* `GPG_PRIVATE_KEY` and `GPG_PASSWORD`: GPG private key and password for signing.
* `SONATYPE_USER` and `SONATYPE_KEY`: Sonatype username and password.
* Each maintainer will have their own set of Sonotype credentials with permission to publish to
the `io.opentelemetry` group prefix.
@ -99,7 +99,7 @@ The following credentials are required for publishing (and automatically set in
User Token.
Additionally, credentials are stored with maintainers via
the [OpenTelemetry 1Password](https://opentelemetry.1password.com/signin) account. The following
the [OpenTelemetry 1Password](https://opentelemetry.1password.com/signin) account. The following
defines the mapping from Github Action secret keys to 1Password keys:
| Github Actions Key | 1Password Key |

View File

@ -32,20 +32,17 @@ The equivalent view configuration would be:
SdkMeterProvider.builder()
.registerView(
InstrumentSelector.builder()
.setInstrumentName("my-instrument")
.setInstrumentType(InstrumentType.COUNTER)
.setMeterSelector(
MeterSelector.builder()
.setName("my-meter")
.setVersion("1.0.0")
.setSchemaUrl("http://example.com")
.build())
.setName("my-instrument")
.setType(InstrumentType.COUNTER)
.setMeterName("my-meter")
.setMeterVersion("1.0.0")
.setMeterSchemaUrl("http://example.com")
.build(),
View.builder()
.setName("new-instrument")
.setDescription("new-description")
.setAggregation(Aggregation.histogram())
.filterAttributes(key -> new HashSet<>(Arrays.asList("foo", "bar")).contains(key))
.setAttributesFilter(key -> new HashSet<>(Arrays.asList("foo", "bar")).contains(key))
.build());
```
@ -76,8 +73,8 @@ Notes on usage:
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
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

View File

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