SqlAttributesExtractor (instrumentation-api 1.3.0 API)

java.lang.Object
- io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor<REQUEST,RESPONSE>
- - io.opentelemetry.instrumentation.api.instrumenter.db.DbAttributesExtractor<REQUEST,RESPONSE>
  - - io.opentelemetry.instrumentation.api.instrumenter.db.SqlAttributesExtractor<REQUEST,RESPONSE>

```
public abstract class SqlAttributesExtractor<REQUEST,RESPONSE>
extends DbAttributesExtractor<REQUEST,RESPONSE>
```
Extractor of database attributes. This class is designed with SQL (or SQL-like) database clients in mind. Aside from adding the same attributes as DbAttributesExtractor, it has two more features:
- It sanitizes the raw SQL query and removes all parameters;
- It enables adding the table name extracted by the sanitizer as a parameter.

Constructor Summary

Constructors
Constructor Description

SqlAttributesExtractor()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract @Nullable io.opentelemetry.api.common.AttributeKey<String>`	`dbTableAttribute()`
`protected void`	`onStart(io.opentelemetry.api.common.AttributesBuilder attributes, REQUEST request)`	Extracts attributes from the `AttributesExtractor` into the `AttributesBuilder` at the beginning of a request.
`protected @Nullable String`	`operation(REQUEST request)`
`protected abstract @Nullable String`	`rawStatement(REQUEST request)`
`protected @Nullable String`	`statement(REQUEST request)`
`protected @Nullable String`	`table(REQUEST request)`

Methods inherited from class io.opentelemetry.instrumentation.api.instrumenter.db.DbAttributesExtractor
connectionString, name, onEnd, system, user

Methods inherited from class io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor
set

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- SqlAttributesExtractor
```
public SqlAttributesExtractor()
```

Method Detail

onStart
```
protected final void onStart(io.opentelemetry.api.common.AttributesBuilder attributes,
                             REQUEST request)
```
Description copied from class: AttributesExtractor

Extracts attributes from the AttributesExtractor into the AttributesBuilder at the beginning of a request.

Overrides:

onStart in class DbAttributesExtractor<REQUEST,RESPONSE>

statement
```
protected final @Nullable String statement(REQUEST request)
```
Specified by:

statement in class DbAttributesExtractor<REQUEST,RESPONSE>

operation
```
protected final @Nullable String operation(REQUEST request)
```
Specified by:

operation in class DbAttributesExtractor<REQUEST,RESPONSE>

table

protected final @Nullable String table(REQUEST request)

dbTableAttribute

protected abstract @Nullable io.opentelemetry.api.common.AttributeKey<String> dbTableAttribute()

rawStatement

protected abstract @Nullable String rawStatement(REQUEST request)