Skip to content

Commit

Permalink
Update database observability topic (#2396)
Browse files Browse the repository at this point in the history
* Update database obserability topic

* Correct full stop
  • Loading branch information
clayton-cornell authored Jan 14, 2025
1 parent 92a9ff2 commit a6a49a7
Showing 1 changed file with 13 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -13,26 +13,26 @@ title: database_observability.mysql
## Usage

```alloy
database_observability.mysql "LABEL" {
data_source_name = DATA_SOURCE_NAME
forward_to = [LOKI_RECEIVERS]
database_observability.mysql "<LABEL>" {
data_source_name = <DATA_SOURCE_NAME>
forward_to = [<LOKI_RECEIVERS>]
}
```

## Arguments

The following arguments are supported:

| Name | Type | Description | Default | Required |
| -------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------- | ------- | -------- |
| `data_source_name` | `secret` | [Data Source Name](https://github.com/go-sql-driver/mysql#dsn-data-source-name) for the MySQL server to connect to. | | yes |
| `forward_to` | `list(LogsReceiver)` | Where to forward log entries after processing. | | yes |
| `collect_interval` | `duration` | How frequently to collect information from database | `"10s"` | no |
| `query_samples_enabled` | `bool` | Whether to enable collection of query samples | `true` | no |
Name | Type | Description | Default | Required
------------------------|----------------------|----------------------------------------------------------|---------|---------
`data_source_name` | `secret` | [Data Source Name][] for the MySQL server to connect to. | | yes
`forward_to` | `list(LogsReceiver)` | Where to forward log entries after processing. | | yes
`collect_interval` | `duration` | How frequently to collect information from database. | `"10s"` | no
`query_samples_enabled` | `bool` | Whether to enable collection of query samples. | `true` | no

## Blocks

The `database_observability.mysql` component does not support any blocks, and is configured fully through arguments.
The `database_observability.mysql` component doesn't support any blocks, and is configured fully through arguments.

## Example

Expand Down Expand Up @@ -68,6 +68,9 @@ loki.write "logs_service" {
}
}
```

[Data Source Name]: https://github.com/go-sql-driver/mysql#dsn-data-source-name

<!-- START GENERATED COMPATIBLE COMPONENTS -->

## Compatible components
Expand Down

0 comments on commit a6a49a7

Please sign in to comment.