Skip to content

Commit

Permalink
[chore] [exporter/clickhouse] Upgrade Logs status to Beta + README (#…
Browse files Browse the repository at this point in the history
…33615)

**Description:**

*NOTE: Depends on merging of #33611, #33614, and #33648*

Logs configuration is unlikely to change further with the new
recommendation of [manual schema
config](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/clickhouseexporter#schema-management).
The logs component of the exporter has proven stability, as seen in
deployments such as [ClickHouse's
Loghouse](https://clickhouse.com/blog/building-a-logging-platform-with-clickhouse-and-saving-millions-over-datadog).

With these points in mind, I suggest we upgrade the status to `beta` for
logs. Traces and metrics can remain `alpha` for now.

**Documentation:**
- Updated metadata.yaml
- Updated README
- Small unrelated change: added/refactored a section that covers tool
visualization
  • Loading branch information
SpencerTorres authored Jul 3, 2024
1 parent f06baf9 commit 50d01eb
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 9 deletions.
29 changes: 29 additions & 0 deletions .chloggen/clickhouse_logs_stability_beta.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: enhancement

# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
component: clickhouseexporter

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Upgrading stability for logs to beta

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [33615]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext: |
The logs exporter has been proven to be stable for large scale production deployments.
Configuration options specific to logs are unlikely to change.
# If your change doesn't affect end users or the exported elements of any package,
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: [user]
18 changes: 11 additions & 7 deletions exporter/clickhouseexporter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,14 @@
<!-- status autogenerated section -->
| Status | |
| ------------- |-----------|
| Stability | [alpha]: traces, metrics, logs |
| Stability | [alpha]: traces, metrics |
| | [beta]: logs |
| Distributions | [contrib] |
| Issues | [![Open issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aopen%20label%3Aexporter%2Fclickhouse%20&label=open&color=orange&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aopen+is%3Aissue+label%3Aexporter%2Fclickhouse) [![Closed issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aclosed%20label%3Aexporter%2Fclickhouse%20&label=closed&color=blue&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aclosed+is%3Aissue+label%3Aexporter%2Fclickhouse) |
| [Code Owners](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CONTRIBUTING.md#becoming-a-code-owner) | [@hanjm](https://www.github.com/hanjm), [@dmitryax](https://www.github.com/dmitryax), [@Frapschen](https://www.github.com/Frapschen), [@SpencerTorres](https://www.github.com/SpencerTorres) |

[alpha]: https://github.com/open-telemetry/opentelemetry-collector#alpha
[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
<!-- end autogenerated section -->

Expand All @@ -29,14 +31,16 @@ as [ClickHouse document says:](https://clickhouse.com/docs/en/introduction/perfo
> We recommend inserting data in packets of at least 1000 rows, or no more than a single request per second. When
> inserting to a MergeTree table from a tab-separated dump, the insertion speed can be from 50 to 200 MB/s.
## User Cases
## Visualization Tools

1. Use [Grafana Clickhouse datasource](https://grafana.com/grafana/plugins/grafana-clickhouse-datasource/) or
[vertamedia-clickhouse-datasource](https://grafana.com/grafana/plugins/vertamedia-clickhouse-datasource/) to make
dashboard.
Support time-series graph, table and logs.
#### Official ClickHouse Plugin for Grafana

2. Analyze logs via powerful ClickHouse SQL.
The official [ClickHouse Datasource for Grafana](https://grafana.com/grafana/plugins/grafana-clickhouse-datasource/) contains features that integrate directly with this exporter.
You can view associated [logs](https://clickhouse.com/docs/en/integrations/grafana/query-builder#logs) and [traces](https://clickhouse.com/docs/en/integrations/grafana/query-builder#traces), as well as visualize other queries such as tables and time series graphs. Learn how to configure the OpenTelemetry integration [here](https://clickhouse.com/docs/en/integrations/grafana/config#opentelemetry).

#### Altinity's ClickHouse Plugin for Grafana

If the official plugin doesn't meet your needs, you can try the [Altinity plugin for ClickHouse](https://grafana.com/grafana/plugins/vertamedia-clickhouse-datasource/), which also supports a wide range of features.

### Logs

Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion exporter/clickhouseexporter/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ scope_name: otelcol/clickhouse
status:
class: exporter
stability:
alpha: [traces, metrics, logs]
alpha: [traces, metrics]
beta: [logs]
distributions: [contrib]
codeowners:
active: [hanjm, dmitryax, Frapschen, SpencerTorres]
Expand Down

0 comments on commit 50d01eb

Please sign in to comment.