@opentelemetry/instrumentation-ioredis - npm Package Compare versions

Comparing version 0.40.0 to 0.41.0

build/src/instrumentation.d.ts

 import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
 import { IORedisInstrumentationConfig } from './types';
 export declare class IORedisInstrumentation extends InstrumentationBase {
-    constructor(_config?: IORedisInstrumentationConfig);
+    protected _config: IORedisInstrumentationConfig;
+    constructor(config?: IORedisInstrumentationConfig);
     init(): InstrumentationNodeModuleDefinition[];
@@ -6,0 +7,0 @@ /**

build/src/instrumentation.js

@@ -30,4 +30,4 @@ "use strict";
 class IORedisInstrumentation extends instrumentation_1.InstrumentationBase {
-    constructor(_config = {}) {
-        super('@opentelemetry/instrumentation-ioredis', version_1.VERSION, Object.assign({}, DEFAULT_CONFIG, _config));
+    constructor(config = {}) {
+        super(version_1.PACKAGE_NAME, version_1.PACKAGE_VERSION, Object.assign({}, DEFAULT_CONFIG, config));
     }
@@ -88,4 +88,4 @@ init() {
                 attributes: {
-                    [semantic_conventions_1.SemanticAttributes.DB_SYSTEM]: semantic_conventions_1.DbSystemValues.REDIS,
-                    [semantic_conventions_1.SemanticAttributes.DB_STATEMENT]: dbStatementSerializer(cmd.name, cmd.args),
+                    [semantic_conventions_1.SEMATTRS_DB_SYSTEM]: semantic_conventions_1.DBSYSTEMVALUES_REDIS,
+                    [semantic_conventions_1.SEMATTRS_DB_STATEMENT]: dbStatementSerializer(cmd.name, cmd.args),
                 },
@@ -106,5 +106,5 @@ });
             span.setAttributes({
-                [semantic_conventions_1.SemanticAttributes.NET_PEER_NAME]: host,
-                [semantic_conventions_1.SemanticAttributes.NET_PEER_PORT]: port,
-                [semantic_conventions_1.SemanticAttributes.DB_CONNECTION_STRING]: `redis://${host}:${port}`,
+                [semantic_conventions_1.SEMATTRS_NET_PEER_NAME]: host,
+                [semantic_conventions_1.SEMATTRS_NET_PEER_PORT]: port,
+                [semantic_conventions_1.SEMATTRS_DB_CONNECTION_STRING]: `redis://${host}:${port}`,
             });
@@ -148,4 +148,4 @@ try {
                 attributes: {
-                    [semantic_conventions_1.SemanticAttributes.DB_SYSTEM]: semantic_conventions_1.DbSystemValues.REDIS,
-                    [semantic_conventions_1.SemanticAttributes.DB_STATEMENT]: 'connect',
+                    [semantic_conventions_1.SEMATTRS_DB_SYSTEM]: semantic_conventions_1.DBSYSTEMVALUES_REDIS,
+                    [semantic_conventions_1.SEMATTRS_DB_STATEMENT]: 'connect',
                 },
@@ -155,5 +155,5 @@ });
             span.setAttributes({
-                [semantic_conventions_1.SemanticAttributes.NET_PEER_NAME]: host,
-                [semantic_conventions_1.SemanticAttributes.NET_PEER_PORT]: port,
-                [semantic_conventions_1.SemanticAttributes.DB_CONNECTION_STRING]: `redis://${host}:${port}`,
+                [semantic_conventions_1.SEMATTRS_NET_PEER_NAME]: host,
+                [semantic_conventions_1.SEMATTRS_NET_PEER_PORT]: port,
+                [semantic_conventions_1.SEMATTRS_DB_CONNECTION_STRING]: `redis://${host}:${port}`,
             });
@@ -160,0 +160,0 @@ try {

build/src/types.d.ts

@@ -34,3 +34,3 @@ /// <reference types="node" />
 /**
- * Options available for the IORedis Instrumentation (see [documentation](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-instrumentation-ioredis#ioredis-instrumentation-options))
+ * Options available for the IORedis Instrumentation (see [documentation](https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/plugins/node/opentelemetry-instrumentation-ioredis/README.md#ioredis-instrumentation-options))
  */
@@ -37,0 +37,0 @@ export interface IORedisInstrumentationConfig extends InstrumentationConfig {

build/src/version.d.ts

@@ -1,2 +0,3 @@
-export declare const VERSION = "0.40.0";
+export declare const PACKAGE_VERSION = "0.41.0";
+export declare const PACKAGE_NAME = "@opentelemetry/instrumentation-ioredis";
 //# sourceMappingURL=version.d.ts.map

build/src/version.js

@@ -18,5 +18,6 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.VERSION = void 0;
+exports.PACKAGE_NAME = exports.PACKAGE_VERSION = void 0;
 // this is autogenerated file, see scripts/version-update.js
-exports.VERSION = '0.40.0';
+exports.PACKAGE_VERSION = '0.41.0';
+exports.PACKAGE_NAME = '@opentelemetry/instrumentation-ioredis';
 //# sourceMappingURL=version.js.map

package.json

 {
   "name": "@opentelemetry/instrumentation-ioredis",
-  "version": "0.40.0",
-  "description": "OpenTelemetry ioredis automatic instrumentation package.",
+  "version": "0.41.0",
+  "description": "OpenTelemetry instrumentation for `ioredis` database redis client for Redis",
   "main": "build/src/index.js",
@@ -52,3 +52,3 @@ "types": "build/src/index.d.ts",
     "@opentelemetry/context-async-hooks": "^1.8.0",
-    "@opentelemetry/contrib-test-utils": "^0.39.0",
+    "@opentelemetry/contrib-test-utils": "^0.40.0",
     "@opentelemetry/sdk-trace-base": "^1.8.0",
@@ -71,8 +71,8 @@ "@opentelemetry/sdk-trace-node": "^1.8.0",
   "dependencies": {
-    "@opentelemetry/instrumentation": "^0.51.0",
+    "@opentelemetry/instrumentation": "^0.52.0",
     "@opentelemetry/redis-common": "^0.36.2",
-    "@opentelemetry/semantic-conventions": "^1.0.0"
+    "@opentelemetry/semantic-conventions": "^1.23.0"
   },
   "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-ioredis#readme",
-  "gitHead": "96a87b48934f0afcf1fe637eed6704f35bd8e973"
+  "gitHead": "0af1b70f7c3c9763c85ac51fa5e334c1e1512020"
 }

README.md

@@ -101,2 +101,16 @@ # OpenTelemetry ioredis Instrumentation for Node.js
 
+## Semantic Conventions
+
+This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which implements Semantic Convention [Version 1.7.0](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.7.0/semantic_conventions/README.md)
+
+Attributes collected:
+
+| Attribute              | Short Description                                                           |
+|------------------------|-----------------------------------------------------------------------------|
+| `db.connection_string` | The connection string used to connect to the database.                      |
+| `db.statement`         | The database statement being executed.                                      |
+| `db.system`            | An identifier for the database management system (DBMS) product being used. |
+| `net.peer.name`        | Remote hostname or similar.                                                 |
+| `net.peer.port`        | Remote port number.                                                         |
+
 ## Useful links
@@ -103,0 +117,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

56580

increased by2.25%

Lines of code

345

increased by0.88%

Number of lines in readme file

130

increased by12.07%

Dependency changes

• + Added@opentelemetry/api-logs@0.52.1(transitive)

• + Added@opentelemetry/instrumentation@0.52.1(transitive)

• + Addedimport-in-the-middle@1.11.2(transitive)

• - Removed@opentelemetry/api-logs@0.51.1(transitive)

• - Removed@opentelemetry/instrumentation@0.51.1(transitive)

• - Removedimport-in-the-middle@1.7.4(transitive)

• Updated@opentelemetry/instrumentation@^0.52.0

• Updated@opentelemetry/semantic-conventions@^1.23.0