Db Attributes

{
  "key": "db.collection.name",
  "brief": "The name of a collection (table, container) within the database.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": true,
  "visibility": "public",
  "example": "users",
  "changelog": [
    {
      "version": "0.1.0",
      "prs": [
        106,
        127
      ]
    },
    {
      "version": "0.0.0"
    }
  ]
}

{
  "key": "db.driver.name",
  "brief": "The name of the driver used for the database connection.",
  "type": "string",
  "pii": {
    "key": "false"
  },
  "is_in_otel": false,
  "visibility": "public",
  "example": "psycopg2",
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        297
      ],
      "description": "Added db.driver.name attribute"
    }
  ]
}

{
  "key": "db.namespace",
  "brief": "The name of the database being accessed.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": true,
  "visibility": "public",
  "example": "customers",
  "alias": [
    "db.name"
  ],
  "changelog": [
    {
      "version": "0.1.0",
      "prs": [
        127
      ]
    },
    {
      "version": "0.0.0"
    }
  ]
}

{
  "key": "db.operation.batch.size",
  "brief": "The number of queries included in a batch operation. Operations are only considered batches when they contain two or more operations, and so db.operation.batch.size SHOULD never be 1.",
  "type": "integer",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": true,
  "visibility": "public",
  "example": 3,
  "changelog": [
    {
      "version": "next",
      "prs": [
        407
      ],
      "description": "Added db.operation.batch.size attribute"
    }
  ]
}

{
  "key": "db.operation.name",
  "brief": "The name of the operation being executed.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": true,
  "visibility": "public",
  "example": "SELECT",
  "alias": [
    "db.operation"
  ],
  "changelog": [
    {
      "version": "0.1.0",
      "prs": [
        127
      ]
    },
    {
      "version": "0.0.0"
    }
  ]
}

{
  "key": "db.query.parameter.<key>",
  "brief": "A query parameter used in db.query.text, with <key> being the parameter name, and the attribute value being a string representation of the parameter value.",
  "has_dynamic_suffix": true,
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": true,
  "visibility": "public",
  "example": "db.query.parameter.foo='123'",
  "changelog": [
    {
      "version": "0.1.0",
      "prs": [
        103,
        127
      ]
    }
  ]
}

{
  "key": "db.query.summary",
  "brief": "A shortened representation of operation(s) in the full query. This attribute must be low-cardinality and should only contain the operation table names.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": true,
  "visibility": "public",
  "example": "SELECT users;",
  "changelog": [
    {
      "version": "0.4.0",
      "prs": [
        208
      ]
    },
    {
      "version": "0.1.0",
      "prs": [
        127
      ]
    },
    {
      "version": "0.0.0"
    }
  ]
}

{
  "key": "db.query.text",
  "brief": "The database parameterized query being executed. Any parameter values (filters, insertion values, etc) should be replaced with parameter placeholders. If applicable, use `db.query.parameter.<key>` to add the parameter value.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": true,
  "visibility": "public",
  "example": "SELECT * FROM users WHERE id = $1",
  "alias": [
    "db.statement"
  ],
  "changelog": [
    {
      "version": "0.4.0",
      "prs": [
        208
      ]
    },
    {
      "version": "0.1.0",
      "prs": [
        127
      ]
    },
    {
      "version": "0.0.0"
    }
  ]
}

{
  "key": "db.redis.connection",
  "brief": "The redis connection name.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "visibility": "public",
  "example": "my-redis-instance",
  "changelog": [
    {
      "version": "0.1.0",
      "prs": [
        127
      ]
    },
    {
      "version": "0.0.0"
    }
  ]
}

{
  "key": "db.redis.key",
  "brief": "The key the Redis command is operating on.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "visibility": "public",
  "example": "user:2047:city",
  "changelog": [
    {
      "version": "0.6.0",
      "prs": [
        326
      ],
      "description": "Added db.redis.key attribute"
    }
  ]
}

{
  "key": "db.redis.parameters",
  "brief": "The array of command parameters given to a redis command.",
  "type": "string[]",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "visibility": "public",
  "example": [
    "test",
    "*"
  ],
  "changelog": [
    {
      "version": "0.0.0"
    }
  ]
}

{
  "key": "db.stored_procedure.name",
  "brief": "The name of a stored procedure being called.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": true,
  "visibility": "public",
  "example": "GetUserById",
  "changelog": [
    {
      "version": "next",
      "prs": [
        398
      ]
    }
  ]
}

{
  "key": "db.system.name",
  "brief": "An identifier for the database management system (DBMS) product being used. See [OpenTelemetry docs](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-spans.md#notes-and-well-known-identifiers-for-dbsystem) for a list of well-known identifiers.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": true,
  "visibility": "public",
  "example": "postgresql",
  "alias": [
    "db.system"
  ],
  "changelog": [
    {
      "version": "0.1.0",
      "prs": [
        127
      ]
    },
    {
      "version": "0.0.0"
    }
  ]
}

{
  "key": "db.user",
  "brief": "The database user.",
  "type": "string",
  "pii": {
    "key": "true"
  },
  "is_in_otel": true,
  "visibility": "public",
  "example": "fancy_user",
  "changelog": [
    {
      "version": "0.0.0"
    }
  ]
}