Skip to content

Commit

Permalink
fix(OTEL): apply style/copy edits
Browse files Browse the repository at this point in the history
  • Loading branch information
ally-sassman committed May 7, 2024
1 parent 2662141 commit b55a6df
Showing 1 changed file with 11 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,17 @@ describing different types of entities. For example, the
conventions define the resource attributes which describe a service or host instance,
respectively.

## Supported entity types
## Supported entity types [#supported-entity-types]

Described here are the New Relic entity types which are supported when using
OpenTelemetry instrumentation. Included for each supported entity type are:

1. The resource attributes required for entity synthesis.
2. Recommended attributes that drive certain aspects of the New Relic UI.
3. Attributes which become [entity tags](/docs/new-relic-solutions/new-relic-one/core-concepts/use-tags-help-organize-find-your-data/),
* The resource attributes required for entity synthesis.
* Recommended attributes that drive certain aspects of the New Relic UI.
* Attributes which become [entity tags](/docs/new-relic-solutions/new-relic-one/core-concepts/use-tags-help-organize-find-your-data/),
when present.

### Services
### Services [#services]

A service entity is synthesized by adhering to the OpenTelemetry resource
semantic conventions describing a
Expand All @@ -47,7 +47,8 @@ for monitoring service entities using OpenTelemetry.

#### Required attributes

* [`service.name`](https://opentelemetry.io/docs/specs/semconv/attributes-registry/service)
* [`service.name`](https://opentelemetry.io/docs/specs/semconv/attributes-registry/service): The entity name you see in the UI comes from this value.
* [`host.name`](https://opentelemetry.io/docs/specs/semconv/attributes-registry/host/): The host name you see in the UI comes from this value.

#### Recommended attributes

Expand All @@ -57,7 +58,7 @@ for monitoring service entities using OpenTelemetry.
* When present, drives the display of any runtime specific UI. For example,
the JVM runtime page for Java applications.

#### Entity tags
#### Entity tags [#entity-tags]

* [`service.namespace`](https://opentelemetry.io/docs/specs/semconv/attributes-registry/service)
* [`telemetry.sdk.language`](https://opentelemetry.io/docs/specs/semconv/attributes-registry/telemetry) (added as language tag)
Expand All @@ -66,7 +67,7 @@ for monitoring service entities using OpenTelemetry.
* [`k8s.namespace.name`](https://opentelemetry.io/docs/specs/semconv/attributes-registry/k8s)
* [`k8s.deployment.name`](https://opentelemetry.io/docs/specs/semconv/attributes-registry/k8s)

### Hosts
### Hosts [#hosts]

A host entity is synthesized by adhering to the OpenTelemetry resource semantic
conventions describing a [host](https://opentelemetry.io/docs/specs/semconv/resource/host).
Expand All @@ -75,12 +76,12 @@ Refer to our
[documentation](/docs/more-integrations/open-source-telemetry-integrations/opentelemetry/collector/opentelemetry-collector-infra-hosts)
for monitoring host entities using the host metrics receiver for the OpenTelemetry collector.

#### Required attributes
#### Required attributes [#required-attributes]

* [`host.name`](https://opentelemetry.io/docs/specs/semconv/attributes-registry/host)
* [`host.id`](https://opentelemetry.io/docs/specs/semconv/attributes-registry/host)

#### Entity tags
#### Entity tags [#entity-tags]

* [`cloud.provider`](https://opentelemetry.io/docs/specs/semconv/attributes-registry/cloud)
* [`cloud.account.id`](https://opentelemetry.io/docs/specs/semconv/attributes-registry/cloud)
Expand Down

0 comments on commit b55a6df

Please sign in to comment.