update CHANGELOG.md and README.md for redis resource semantic convention

open-telemetry · Dec 7, 2021 · e44d562 · e44d562
1 parent 3ca8c0a
commit e44d562
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -24,6 +24,9 @@ release.
 
 ### Semantic Conventions
 
+- Add `redis.instance` Resource attribute in Redis.
+  ([#2145](https://github.com/open-telemetry/opentelemetry-specification/pull/2145))
+
 ### Compatibility
 
 ### OpenTelemetry Protocol

diff --git a/semantic_conventions/resource/redis.yaml b/semantic_conventions/resource/redis.yaml
@@ -7,5 +7,8 @@ groups:
       - id: instance
         type: string
         brief: >
-          Reported name of the redis instance
-        examples: ['localhost:6379']
+          Reported name of the Redis instance. This can be in the form
+          `{host}:{port}` or any other name provided manually while configuring
+          the instrumentation and defaults to the `endpoint` value provided in the
+          configuration.
+        examples: ['localhost:6379', 'product_info_redis']
diff --git a/specification/resource/semantic_conventions/README.md b/specification/resource/semantic_conventions/README.md
@@ -19,6 +19,7 @@ This document defines standard attributes for resources. These attributes are ty
 - [Compute Unit](#compute-unit)
 - [Compute Instance](#compute-instance)
 - [Environment](#environment)
+- [Database](#database)
 - [Version attributes](#version-attributes)
 - [Cloud-Provider-Specific Attributes](#cloud-provider-specific-attributes)
 
@@ -157,6 +158,12 @@ Attributes defining a running environment (e.g. Operating System, Cloud, Data Ce
   - [Deployment Environment](./deployment_environment.md)
   - [Kubernetes](./k8s.md)
 
+## Database
+
+Attributes defining a database service.
+
+- [Redis](./redis.md)
+
 ## Version attributes
 
 Version attributes, such as `service.version`, are values of type `string`. They are

diff --git a/specification/resource/semantic_conventions/redis.md b/specification/resource/semantic_conventions/redis.md
@@ -9,5 +9,5 @@
 <!-- semconv redis -->
 | Attribute  | Type | Description  | Examples  | Required |
 |---|---|---|---|---|
-| `redis.instance` | string | Reported name of the redis instance | `localhost:6379` | No |
+| `redis.instance` | string | Reported name of the Redis instance. This can be in the form `{host}:{port}` or any other name provided manually while configuring the instrumentation and defaults to the `endpoint` value provided in the configuration. | `localhost:6379`; `product_info_redis` | No |
 <!-- endsemconv -->