clickhouse-datasource/otel-semconv.yaml at main · grafana/clickhouse-datasource · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
# otel-semconv.yaml — generated by otel-scout on 2026-03-19

plugin_id: grafana-clickhouse-datasource
repo: grafana/clickhouse-datasource
domain: db
spans:
    - name: query_data
      kind: client
      description: Created when the plugin receives a QueryData request and dispatches queries to ClickHouse via the sqlds framework
      required_attributes:
        - name: db.system
          type: string
          semconv_ref: https://opentelemetry.io/docs/specs/semconv/attributes-registry/db/#db-system
          description: The database management system being queried
          example: clickhouse
        - name: grafana.plugin.id
          type: string
          semconv_ref: https://opentelemetry.io/docs/specs/semconv/attributes-registry/
          description: The Grafana plugin identifier
          example: grafana-clickhouse-datasource
      optional_attributes:
        - name: db.statement
          type: string
          semconv_ref: https://opentelemetry.io/docs/specs/semconv/attributes-registry/db/#db-statement
          description: The raw SQL query string sent to ClickHouse after macro interpolation
          example: SELECT timestamp, value FROM metrics WHERE timestamp > '2024-01-01'
        - name: db.operation
          type: string
          semconv_ref: https://opentelemetry.io/docs/specs/semconv/attributes-registry/db/#db-operation
          description: The type of database operation being performed
          example: SELECT
        - name: datasource.uid
          type: string
          semconv_ref: https://opentelemetry.io/docs/specs/semconv/attributes-registry/
          description: The unique identifier of the Grafana datasource instance
          example: abc123
        - name: request.query_count
          type: int
          semconv_ref: https://opentelemetry.io/docs/specs/semconv/attributes-registry/
          description: The number of queries in the QueryData request
          example: "3"
        - name: status
          type: string
          semconv_ref: https://opentelemetry.io/docs/specs/semconv/attributes-registry/
          description: The outcome status of the request (ok, error, cancelled)
          example: ok
        - name: error.source
          type: string
          semconv_ref: https://opentelemetry.io/docs/specs/semconv/attributes-registry/
          description: The source of an error (plugin or downstream)
          example: downstream
    - name: db.query
      kind: client
      description: Created for each individual SQL query execution against the ClickHouse database via database/sql
      required_attributes:
        - name: db.system
          type: string
          semconv_ref: https://opentelemetry.io/docs/specs/semconv/attributes-registry/db/#db-system
          description: The database management system being queried
          example: clickhouse
      optional_attributes:
        - name: db.statement
          type: string
          semconv_ref: https://opentelemetry.io/docs/specs/semconv/attributes-registry/db/#db-statement
          description: The SQL query string executed against ClickHouse
          example: SELECT timestamp, value FROM metrics WHERE timestamp > ?
        - name: db.operation
          type: string
          semconv_ref: https://opentelemetry.io/docs/specs/semconv/attributes-registry/db/#db-operation
          description: The type of database operation (SELECT, INSERT, etc.)
          example: SELECT
        - name: db.query.ref_id
          type: string
          semconv_ref: https://opentelemetry.io/docs/specs/semconv/attributes-registry/
          description: The Grafana query reference ID associated with this database query
          example: A
        - name: db.query.type
          type: string
          semconv_ref: https://opentelemetry.io/docs/specs/semconv/attributes-registry/
          description: The type of the query (e.g., table, time series, logs)
          example: time_series
        - name: db.row_count
          type: int
          semconv_ref: https://opentelemetry.io/docs/specs/semconv/attributes-registry/
          description: The number of rows returned by the query
          example: "1500"
        - name: db.query.duration_ms
          type: float64
          semconv_ref: https://opentelemetry.io/docs/specs/semconv/attributes-registry/
          description: The duration of the query execution in milliseconds
          example: "245.3"
    - name: db.connect
      kind: client
      description: Created when a new database connection is established to the ClickHouse server, including reconnection attempts
      required_attributes:
        - name: db.system
          type: string
          semconv_ref: https://opentelemetry.io/docs/specs/semconv/attributes-registry/db/#db-system
          description: The database management system being connected to
          example: clickhouse
      optional_attributes:
        - name: server.address
          type: string
          semconv_ref: https://opentelemetry.io/docs/specs/semconv/attributes-registry/server/
          description: The hostname or IP address of the ClickHouse server
          example: clickhouse.example.com
        - name: server.port
          type: int
          semconv_ref: https://opentelemetry.io/docs/specs/semconv/attributes-registry/server/
          description: The port number of the ClickHouse server
          example: "9000"
        - name: db.name
          type: string
          semconv_ref: https://opentelemetry.io/docs/specs/semconv/attributes-registry/db/#db-name
          description: The name of the database being connected to
          example: default
        - name: db.connection.is_reconnect
          type: bool
          semconv_ref: https://opentelemetry.io/docs/specs/semconv/attributes-registry/
          description: Whether this connection is a reconnection attempt after a failed query
          example: "true"
        - name: network.transport
          type: string
          semconv_ref: https://opentelemetry.io/docs/specs/semconv/attributes-registry/network/
          description: The transport protocol used (tcp, http)
          example: tcp