@opentelemetry/semantic-conventions - npm Package Compare versions

Comparing version 0.9.0 to 0.10.0

build/src/trace/database.d.ts

@@ -6,8 +6,111 @@ /**
 export declare const DatabaseAttribute: {
+    /**
+     * An identifier for the database management system (DBMS) product being used.
+     *
+     * @remarks
+     * Required.
+     */
+    DB_SYSTEM: string;
+    /**
+     * The connection string used to connect to the database.
+     * It is recommended to remove embedded credentials.
+     *
+     * @remarks
+     * Optional.
+     */
+    DB_CONNECTION_STRING: string;
+    /**
+     * Username for accessing the database, e.g., "readonly_user" or "reporting_user".
+     *
+     * @remarks
+     * Optional.
+     */
+    DB_USER: string;
+    /**
+     * If no [tech-specific attribute](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/database.md#call-level-attributes-for-specific-technologies)
+     * is defined in the list below,
+     * this attribute is used to report the name of the database being accessed.
+     * For commands that switch the database,this should be set to the
+     * target database (even if the command fails).
+     *
+     * @remarks
+     * Required if applicable and no more specific attribute is defined.
+     */
+    DB_NAME: string;
+    /**
+     * The database statement being executed.
+     * Note that the value may be sanitized to exclude sensitive information.
+     * E.g., for db.system="other_sql", "SELECT * FROM wuser_table";
+     * for db.system="redis", "SET mykey 'WuValue'".
+     *
+     * @remarks
+     * Required if applicable.
+     */
+    DB_STATEMENT: string;
+    /**
+     * The name of the operation being executed,
+     * e.g. the MongoDB command name such as findAndModify.
+     * While it would semantically make sense to set this,
+     * e.g., to an SQL keyword like SELECT or INSERT,
+     * it is not recommended to attempt any client-side parsing of
+     * db.statement just to get this property (the back end can do that if required).
+     *
+     * @remarks
+     * Required if db.statement is not applicable.
+     */
+    DB_OPERATION: string;
+    /**
+     * The instance name connecting to.
+     * This name is used to determine the port of a named instance.
+     *
+     * @remarks
+     * If setting a `db.mssql.instance_name`,
+     * `net.peer.port` is no longer required (but still recommended if non-standard)
+     */
+    DB_MSSSQL_INSTANCE_NAME: string;
+    /**
+     * The fully-qualified class name of the Java Database Connectivity (JDBC) driver used to connect,
+     * e.g., "org.postgresql.Driver" or "com.microsoft.sqlserver.jdbc.SQLServerDriver".
+     *
+     * @remarks
+     * Optional.
+     */
+    DB_JDBC_DRIVER_CLASSNAME: string;
+    /**
+     * The name of the keyspace being accessed. To be used instead of the generic db.name attribute.
+     *
+     * @remarks
+     * Required.
+     */
+    DB_CASSANDRA_KEYSPACE: string;
+    /**
+     * The [HBase namespace](https://hbase.apache.org/book.html#_namespace) being accessed.
+     * To be used instead of the generic db.name attribute.
+     *
+     * @remarks
+     * Required.
+     */
+    DB_HBASE_NAMESPACE: string;
+    /**
+     * The index of the database being accessed as used in the [SELECT command](https://redis.io/commands/select),
+     * provided as an integer. To be used instead of the generic db.name attribute.
+     *
+     * @remarks
+     * Required if other than the default database (0).
+     */
+    DB_REDIS_DATABASE_INDEX: string;
+    /**
+     * The collection being accessed within the database stated in db.name.
+     *
+     * @remarks
+     * Required.
+     */
+    DB_MONGODB_COLLECTION: string;
+    /** Deprecated. Not in spec. */
     DB_TYPE: string;
+    /** Deprecated. Not in spec. */
     DB_INSTANCE: string;
-    DB_STATEMENT: string;
+    /** Deprecated. Not in spec. */
     DB_URL: string;
-    DB_USER: string;
 };
 //# sourceMappingURL=database.d.ts.map

build/src/trace/database.js

@@ -24,10 +24,117 @@ "use strict";
 exports.DatabaseAttribute = {
-    // db (required)
+    // Connection-level attributes
+    /**
+     * An identifier for the database management system (DBMS) product being used.
+     *
+     * @remarks
+     * Required.
+     */
+    DB_SYSTEM: 'db.system',
+    /**
+     * The connection string used to connect to the database.
+     * It is recommended to remove embedded credentials.
+     *
+     * @remarks
+     * Optional.
+     */
+    DB_CONNECTION_STRING: 'db.connection_string',
+    /**
+     * Username for accessing the database, e.g., "readonly_user" or "reporting_user".
+     *
+     * @remarks
+     * Optional.
+     */
+    DB_USER: 'db.user',
+    // Please see ./general.ts for NET_PEER_NAME, NET_PEER_IP, NET_PEER_PORT, NET_TRANSPORT
+    // Call-level attributes
+    /**
+     * If no [tech-specific attribute](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/database.md#call-level-attributes-for-specific-technologies)
+     * is defined in the list below,
+     * this attribute is used to report the name of the database being accessed.
+     * For commands that switch the database,this should be set to the
+     * target database (even if the command fails).
+     *
+     * @remarks
+     * Required if applicable and no more specific attribute is defined.
+     */
+    DB_NAME: 'db.name',
+    /**
+     * The database statement being executed.
+     * Note that the value may be sanitized to exclude sensitive information.
+     * E.g., for db.system="other_sql", "SELECT * FROM wuser_table";
+     * for db.system="redis", "SET mykey 'WuValue'".
+     *
+     * @remarks
+     * Required if applicable.
+     */
+    DB_STATEMENT: 'db.statement',
+    /**
+     * The name of the operation being executed,
+     * e.g. the MongoDB command name such as findAndModify.
+     * While it would semantically make sense to set this,
+     * e.g., to an SQL keyword like SELECT or INSERT,
+     * it is not recommended to attempt any client-side parsing of
+     * db.statement just to get this property (the back end can do that if required).
+     *
+     * @remarks
+     * Required if db.statement is not applicable.
+     */
+    DB_OPERATION: 'db.operation',
+    // Connection-level attributes for specific technologies
+    /**
+     * The instance name connecting to.
+     * This name is used to determine the port of a named instance.
+     *
+     * @remarks
+     * If setting a `db.mssql.instance_name`,
+     * `net.peer.port` is no longer required (but still recommended if non-standard)
+     */
+    DB_MSSSQL_INSTANCE_NAME: 'db.mssql.instance_name',
+    /**
+     * The fully-qualified class name of the Java Database Connectivity (JDBC) driver used to connect,
+     * e.g., "org.postgresql.Driver" or "com.microsoft.sqlserver.jdbc.SQLServerDriver".
+     *
+     * @remarks
+     * Optional.
+     */
+    DB_JDBC_DRIVER_CLASSNAME: 'db.jdbc.driver_classname',
+    // Call-level attributes for specific technologies
+    /**
+     * The name of the keyspace being accessed. To be used instead of the generic db.name attribute.
+     *
+     * @remarks
+     * Required.
+     */
+    DB_CASSANDRA_KEYSPACE: 'db.cassandra.keyspace',
+    /**
+     * The [HBase namespace](https://hbase.apache.org/book.html#_namespace) being accessed.
+     * To be used instead of the generic db.name attribute.
+     *
+     * @remarks
+     * Required.
+     */
+    DB_HBASE_NAMESPACE: 'db.hbase.namespace',
+    /**
+     * The index of the database being accessed as used in the [SELECT command](https://redis.io/commands/select),
+     * provided as an integer. To be used instead of the generic db.name attribute.
+     *
+     * @remarks
+     * Required if other than the default database (0).
+     */
+    DB_REDIS_DATABASE_INDEX: 'db.redis.database_index',
+    /**
+     * The collection being accessed within the database stated in db.name.
+     *
+     * @remarks
+     * Required.
+     */
+    DB_MONGODB_COLLECTION: 'db.mongodb.collection',
+    // Not in spec.
+    /** Deprecated. Not in spec. */
     DB_TYPE: 'db.type',
+    /** Deprecated. Not in spec. */
     DB_INSTANCE: 'db.instance',
-    DB_STATEMENT: 'db.statement',
+    /** Deprecated. Not in spec. */
     DB_URL: 'db.url',
-    // db (optional)
-    DB_USER: 'db.user',
 };
 //# sourceMappingURL=database.js.map

build/src/trace/general.d.ts

@@ -0,3 +1,6 @@
+/**
+ * General purpose networking attributes defined by the OpenTelemetry Semantic Conventions Specification
+ * https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/span-general.md
+ */
 export declare const GeneralAttribute: {
-    COMPONENT: string;
     NET_PEER_IP: string;
@@ -4,0 +7,0 @@ NET_PEER_ADDRESS: string;

build/src/trace/general.js

 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GeneralAttribute = void 0;
 /*
@@ -19,5 +17,9 @@ * Copyright The OpenTelemetry Authors
  */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GeneralAttribute = void 0;
+/**
+ * General purpose networking attributes defined by the OpenTelemetry Semantic Conventions Specification
+ * https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/span-general.md
+ */
 exports.GeneralAttribute = {
-    // Not in spec
-    COMPONENT: 'component',
     NET_PEER_IP: 'net.peer.ip',
@@ -24,0 +26,0 @@ NET_PEER_ADDRESS: 'net.peer.address',

build/src/trace/http.d.ts

@@ -13,2 +13,3 @@ export declare const HttpAttribute: {
     HTTP_SCHEME: string;
+    HTTP_RESPONSE_CONTENT_LENGTH: string;
     HTTP_ERROR_NAME: string;
@@ -15,0 +16,0 @@ HTTP_ERROR_MESSAGE: string;

build/src/trace/http.js

@@ -31,2 +31,3 @@ "use strict";
     HTTP_SCHEME: 'http.scheme',
+    HTTP_RESPONSE_CONTENT_LENGTH: 'http.response_content_length',
     // NOT ON OFFICIAL SPEC
@@ -33,0 +34,0 @@ HTTP_ERROR_NAME: 'http.error_name',

build/src/version.d.ts

@@ -1,2 +0,2 @@
-export declare const VERSION = "0.9.0";
+export declare const VERSION = "0.10.0";
 //# sourceMappingURL=version.d.ts.map

build/src/version.js

@@ -20,3 +20,3 @@ "use strict";
 // this is autogenerated file, see scripts/version-update.js
-exports.VERSION = '0.9.0';
+exports.VERSION = '0.10.0';
 //# sourceMappingURL=version.js.map

package.json

 {
   "name": "@opentelemetry/semantic-conventions",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "OpenTelemetry semantic conventions",
@@ -34,2 +34,3 @@ "main": "build/src/index.js",
     "build/src/**/*.js",
+    "build/src/**/*.js.map",
     "build/src/**/*.d.ts",
@@ -44,6 +45,6 @@ "doc",
   "devDependencies": {
-    "@types/mocha": "7.0.2",
-    "@types/node": "14.0.13",
+    "@types/mocha": "8.0.0",
+    "@types/node": "14.0.25",
     "@types/sinon": "9.0.4",
-    "codecov": "3.7.0",
+    "codecov": "3.7.2",
     "gts": "2.0.2",
@@ -57,4 +58,5 @@ "mocha": "7.2.0",
     "ts-node": "8.10.2",
-    "typescript": "3.9.5"
-  }
+    "typescript": "3.9.7"
+  },
+  "gitHead": "ab62a4d69b99b3a8c9c26100c04f3226af7859df"
 }

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

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

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

36278

increased by42.54%

Number of package files

24

increased by41.18%

Lines of code

486

increased by80.67%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes