# Vert.x SQL Client

<!-- llms-txt-link: /llms.txt -->

> OpenTelemetry Java agent instrumentation

This instrumentation enables database client spans and database client metrics for Vert.x SQL Client operations.

- **Name**: `vertx-sql-client-5.0`
- **Scope**: `io.opentelemetry.vertx-sql-client-5.0`
- **Target versions**: `io.vertx:vertx-sql-client:[5.0.0,)`
- **Library**: https://github.com/eclipse-vertx/vertx-sql-client

## Telemetry

### When `default`

**Spans**

| Span kind | Attributes |
| --- | --- |
| CLIENT | `db.name` (STRING), `db.operation` (STRING), `db.sql.table` (STRING), `db.statement` (STRING), `db.user` (STRING), `peer.service` (STRING), `server.address` (STRING), `server.port` (LONG) |

### When `otel.semconv-stability.opt-in=database,service.peer`

**Metrics**

| Metric | Instrument | Type | Unit | Description |
| --- | --- | --- | --- | --- |
| `db.client.operation.duration` | histogram | HISTOGRAM | s | Duration of database client operations. |

| Metric | Attributes |
| --- | --- |
| `db.client.operation.duration` | `db.namespace` (STRING), `db.query.summary` (STRING), `db.system.name` (STRING), `server.address` (STRING), `server.port` (LONG) |

**Spans**

| Span kind | Attributes |
| --- | --- |
| CLIENT | `db.namespace` (STRING), `db.operation.batch.size` (LONG), `db.query.summary` (STRING), `db.query.text` (STRING), `db.system.name` (STRING), `error.type` (STRING), `server.address` (STRING), `server.port` (LONG), `service.peer.name` (STRING) |

## Configuration

| Option | Type | Default | Description |
| --- | --- | --- | --- |
| `otel.instrumentation.common.db.query-sanitization.enabled` | boolean | true | Enables query sanitization for database queries. |

## Data

- **JSON (latest)**: [/data/javaagent/instrumentations/vertx-sql-client-5.0/latest.json](/data/javaagent/instrumentations/vertx-sql-client-5.0/latest.json)
- **JSON (pinned)**: [/data/javaagent/instrumentations/vertx-sql-client-5.0/vertx-sql-client-5.0-a90c1d314579.json](/data/javaagent/instrumentations/vertx-sql-client-5.0/vertx-sql-client-5.0-a90c1d314579.json)
- **Explore**: [/java-agent/instrumentation/vertx-sql-client-5.0](/java-agent/instrumentation/vertx-sql-client-5.0)