Skip to content

Commit 1d3f603

Browse files
jaydelucajaydeluca
authored
Elasticsearch instrumentation metadata (#14164)
1 parent 1190ca2 commit 1d3f603

File tree

22 files changed

+821
-321
lines changed

22 files changed

+821
-321
lines changed

‎docs/instrumentation-list.yaml‎

Lines changed: 273 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1100,6 +1100,9 @@ libraries:
11001100
default: false
11011101
elasticsearch:
11021102
- name: elasticsearch-api-client-7.16
1103+
description: This instrumentation provides client spans for Elasticsearch API
1104+
client requests for version 7 of the client. Versions 8.10 and later have native
1105+
support for OpenTelemetry.
11031106
source_path: instrumentation/elasticsearch/elasticsearch-api-client-7.16
11041107
scope:
11051108
name: io.opentelemetry.elasticsearch-api-client-7.16
@@ -1108,6 +1111,7 @@ libraries:
11081111
- co.elastic.clients:elasticsearch-java:[7.16,7.17.20)
11091112
- co.elastic.clients:elasticsearch-java:[8.0.0,8.10)
11101113
- name: elasticsearch-rest-5.0
1114+
description: This instrumentation provides tracing for Elasticsearch REST clients.
11111115
source_path: instrumentation/elasticsearch/elasticsearch-rest-5.0
11121116
scope:
11131117
name: io.opentelemetry.elasticsearch-rest-5.0
@@ -1122,7 +1126,23 @@ libraries:
11221126
may contain personal or sensitive information.
11231127
type: boolean
11241128
default: false
1129+
telemetry:
1130+
- when: default
1131+
spans:
1132+
- span_kind: CLIENT
1133+
attributes:
1134+
- name: db.system
1135+
type: STRING
1136+
- name: http.request.method
1137+
type: STRING
1138+
- name: server.address
1139+
type: STRING
1140+
- name: server.port
1141+
type: LONG
1142+
- name: url.full
1143+
type: STRING
11251144
- name: elasticsearch-rest-6.4
1145+
description: This instrumentation provides tracing for Elasticsearch REST clients.
11261146
source_path: instrumentation/elasticsearch/elasticsearch-rest-6.4
11271147
scope:
11281148
name: io.opentelemetry.elasticsearch-rest-6.4
@@ -1135,7 +1155,23 @@ libraries:
11351155
Enable the capture of search query bodies. It is important to note that Elasticsearch queries may contain personal or sensitive information.
11361156
type: boolean
11371157
default: false
1158+
telemetry:
1159+
- when: default
1160+
spans:
1161+
- span_kind: CLIENT
1162+
attributes:
1163+
- name: db.system
1164+
type: STRING
1165+
- name: http.request.method
1166+
type: STRING
1167+
- name: server.address
1168+
type: STRING
1169+
- name: server.port
1170+
type: LONG
1171+
- name: url.full
1172+
type: STRING
11381173
- name: elasticsearch-rest-7.0
1174+
description: This instrumentation provides tracing for Elasticsearch REST clients.
11391175
source_path: instrumentation/elasticsearch/elasticsearch-rest-7.0
11401176
scope:
11411177
name: io.opentelemetry.elasticsearch-rest-7.0
@@ -1150,30 +1186,267 @@ libraries:
11501186
Enable the capture of search query bodies. It is important to note that Elasticsearch queries may contain personal or sensitive information.
11511187
type: boolean
11521188
default: false
1189+
telemetry:
1190+
- when: default
1191+
spans:
1192+
- span_kind: CLIENT
1193+
attributes:
1194+
- name: db.system
1195+
type: STRING
1196+
- name: http.request.method
1197+
type: STRING
1198+
- name: server.address
1199+
type: STRING
1200+
- name: server.port
1201+
type: LONG
1202+
- name: url.full
1203+
type: STRING
11531204
- name: elasticsearch-transport-5.0
1205+
description: |
1206+
This instrumentation provides client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes.
11541207
source_path: instrumentation/elasticsearch/elasticsearch-transport-5.0
11551208
scope:
11561209
name: io.opentelemetry.elasticsearch-transport-5.0
11571210
target_versions:
11581211
javaagent:
11591212
- org.elasticsearch.client:transport:[5.0.0,5.3.0)
11601213
- org.elasticsearch:elasticsearch:[5.0.0,5.3.0)
1214+
configurations:
1215+
- name: otel.instrumentation.elasticsearch.experimental-span-attributes
1216+
description: Enable the capture of experimental span attributes.
1217+
type: boolean
1218+
default: false
1219+
telemetry:
1220+
- when: default
1221+
spans:
1222+
- span_kind: CLIENT
1223+
attributes:
1224+
- name: db.operation
1225+
type: STRING
1226+
- name: db.system
1227+
type: STRING
1228+
- name: network.peer.address
1229+
type: STRING
1230+
- name: network.peer.port
1231+
type: LONG
1232+
- when: otel.instrumentation.elasticsearch.experimental-span-attributes=true
1233+
spans:
1234+
- span_kind: CLIENT
1235+
attributes:
1236+
- name: db.operation
1237+
type: STRING
1238+
- name: db.system
1239+
type: STRING
1240+
- name: elasticsearch.action
1241+
type: STRING
1242+
- name: elasticsearch.id
1243+
type: STRING
1244+
- name: elasticsearch.request
1245+
type: STRING
1246+
- name: elasticsearch.request.indices
1247+
type: STRING
1248+
- name: elasticsearch.request.write.type
1249+
type: STRING
1250+
- name: elasticsearch.response.status
1251+
type: LONG
1252+
- name: elasticsearch.shard.replication.failed
1253+
type: LONG
1254+
- name: elasticsearch.shard.replication.successful
1255+
type: LONG
1256+
- name: elasticsearch.shard.replication.total
1257+
type: LONG
1258+
- name: elasticsearch.type
1259+
type: STRING
1260+
- name: elasticsearch.version
1261+
type: LONG
1262+
- name: network.peer.address
1263+
type: STRING
1264+
- name: network.peer.port
1265+
type: LONG
1266+
- when: otel.semconv-stability.opt-in=database
1267+
spans:
1268+
- span_kind: CLIENT
1269+
attributes:
1270+
- name: db.operation.name
1271+
type: STRING
1272+
- name: db.system.name
1273+
type: STRING
1274+
- name: error.type
1275+
type: STRING
1276+
- name: network.peer.address
1277+
type: STRING
1278+
- name: network.peer.port
1279+
type: LONG
11611280
- name: elasticsearch-transport-5.3
1281+
description: |
1282+
This instrumentation provides client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes.
11621283
source_path: instrumentation/elasticsearch/elasticsearch-transport-5.3
11631284
scope:
11641285
name: io.opentelemetry.elasticsearch-transport-5.3
11651286
target_versions:
11661287
javaagent:
11671288
- org.elasticsearch.client:transport:[5.3.0,6.0.0)
11681289
- org.elasticsearch:elasticsearch:[5.3.0,6.0.0)
1290+
configurations:
1291+
- name: otel.instrumentation.elasticsearch.experimental-span-attributes
1292+
description: Enable the capture of experimental span attributes.
1293+
type: boolean
1294+
default: false
1295+
telemetry:
1296+
- when: default
1297+
spans:
1298+
- span_kind: CLIENT
1299+
attributes:
1300+
- name: db.operation
1301+
type: STRING
1302+
- name: db.system
1303+
type: STRING
1304+
- name: network.peer.address
1305+
type: STRING
1306+
- name: network.peer.port
1307+
type: LONG
1308+
- when: otel.instrumentation.elasticsearch.experimental-span-attributes=true
1309+
spans:
1310+
- span_kind: CLIENT
1311+
attributes:
1312+
- name: db.operation
1313+
type: STRING
1314+
- name: db.system
1315+
type: STRING
1316+
- name: elasticsearch.action
1317+
type: STRING
1318+
- name: elasticsearch.id
1319+
type: STRING
1320+
- name: elasticsearch.request
1321+
type: STRING
1322+
- name: elasticsearch.request.indices
1323+
type: STRING
1324+
- name: elasticsearch.request.search.types
1325+
type: STRING
1326+
- name: elasticsearch.request.write.type
1327+
type: STRING
1328+
- name: elasticsearch.request.write.version
1329+
type: LONG
1330+
- name: elasticsearch.response.status
1331+
type: LONG
1332+
- name: elasticsearch.shard.broadcast.failed
1333+
type: LONG
1334+
- name: elasticsearch.shard.broadcast.successful
1335+
type: LONG
1336+
- name: elasticsearch.shard.broadcast.total
1337+
type: LONG
1338+
- name: elasticsearch.shard.replication.failed
1339+
type: LONG
1340+
- name: elasticsearch.shard.replication.successful
1341+
type: LONG
1342+
- name: elasticsearch.shard.replication.total
1343+
type: LONG
1344+
- name: elasticsearch.type
1345+
type: STRING
1346+
- name: elasticsearch.version
1347+
type: LONG
1348+
- name: network.peer.address
1349+
type: STRING
1350+
- name: network.peer.port
1351+
type: LONG
1352+
- when: otel.semconv-stability.opt-in=database
1353+
spans:
1354+
- span_kind: CLIENT
1355+
attributes:
1356+
- name: db.operation.name
1357+
type: STRING
1358+
- name: db.system.name
1359+
type: STRING
1360+
- name: error.type
1361+
type: STRING
1362+
- name: network.peer.address
1363+
type: STRING
1364+
- name: network.peer.port
1365+
type: LONG
11691366
- name: elasticsearch-transport-6.0
1367+
description: |
1368+
This instrumentation provides client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes.
11701369
source_path: instrumentation/elasticsearch/elasticsearch-transport-6.0
11711370
scope:
11721371
name: io.opentelemetry.elasticsearch-transport-6.0
11731372
target_versions:
11741373
javaagent:
11751374
- org.elasticsearch:elasticsearch:[6.0.0,8.0.0)
11761375
- org.elasticsearch.client:transport:[6.0.0,)
1376+
configurations:
1377+
- name: otel.instrumentation.elasticsearch.experimental-span-attributes
1378+
description: Enable the capture of experimental span attributes.
1379+
type: boolean
1380+
default: false
1381+
telemetry:
1382+
- when: default
1383+
spans:
1384+
- span_kind: CLIENT
1385+
attributes:
1386+
- name: db.operation
1387+
type: STRING
1388+
- name: db.system
1389+
type: STRING
1390+
- name: network.peer.address
1391+
type: STRING
1392+
- name: network.peer.port
1393+
type: LONG
1394+
- name: network.type
1395+
type: STRING
1396+
- when: otel.instrumentation.elasticsearch.experimental-span-attributes=true
1397+
spans:
1398+
- span_kind: CLIENT
1399+
attributes:
1400+
- name: db.operation
1401+
type: STRING
1402+
- name: db.system
1403+
type: STRING
1404+
- name: elasticsearch.action
1405+
type: STRING
1406+
- name: elasticsearch.id
1407+
type: STRING
1408+
- name: elasticsearch.request
1409+
type: STRING
1410+
- name: elasticsearch.request.indices
1411+
type: STRING
1412+
- name: elasticsearch.request.write.type
1413+
type: STRING
1414+
- name: elasticsearch.request.write.version
1415+
type: LONG
1416+
- name: elasticsearch.response.status
1417+
type: LONG
1418+
- name: elasticsearch.shard.replication.failed
1419+
type: LONG
1420+
- name: elasticsearch.shard.replication.successful
1421+
type: LONG
1422+
- name: elasticsearch.shard.replication.total
1423+
type: LONG
1424+
- name: elasticsearch.type
1425+
type: STRING
1426+
- name: elasticsearch.version
1427+
type: LONG
1428+
- name: network.peer.address
1429+
type: STRING
1430+
- name: network.peer.port
1431+
type: LONG
1432+
- name: network.type
1433+
type: STRING
1434+
- when: otel.semconv-stability.opt-in=database
1435+
spans:
1436+
- span_kind: CLIENT
1437+
attributes:
1438+
- name: db.operation.name
1439+
type: STRING
1440+
- name: db.system.name
1441+
type: STRING
1442+
- name: error.type
1443+
type: STRING
1444+
- name: network.peer.address
1445+
type: STRING
1446+
- name: network.peer.port
1447+
type: LONG
1448+
- name: network.type
1449+
type: STRING
11771450
executors:
11781451
- name: executors
11791452
description: |

0 commit comments

Comments
 (0)