mirror of
https://github.com/apache/druid.git
synced 2025-02-07 18:48:33 +00:00
30c24df4d3
* Add config option for namespacePrefix opentsdb emitter sends metric names to opentsdb verbatim as what druid names them, for example "query.count", this doesn't fit well with a central opentsdb server which might have namespaced metrics, for example "druid.query.count". This adds support for adding an optional prefix. The prefix also gets a trailing dot (.), after it, so the metric name becomes <namespacePrefix>.<metricname> configureable as "druid.emitter.opentsdb.namespacePrefix", as documented. Co-authored-by: Martin Gerholm <martin.gerholm@deltaprojects.com> Signed-off-by: Martin Gerholm <martin.gerholm@deltaprojects.com> Signed-off-by: Björn Zettergren <bjorn.zettergren@deltaprojects.com> * Spelling for PR #9372 Added "namespacePrefix" to .spelling exceptions, it's a variable name used in documentation for opentsdb-emitter. * fixing tests for PR #9372 changed naming of variables to be more descriptive added test of prefix being an empty string: "". added a conditional to buildNamespacePrefix to check for empty string being fed if EventConverter called without OpentsdbEmitterConfig instance. * fixing checkstyle errors for PR #9372 used == to compare literal string, should be equals() * cleaned up and updated PR #9372 Created a buildMetric function as suggested by clintropolis, and removed redundant tests for empty strings as they're only used when calling EventConverter directly without going through OpentsdbEmitterConfig. * consistent naming of tests PR #9372 Changed names of tests in files to match better with what it was actually testing changed check for Strings.isNullOrEmpty to just check for `null`, as empty string valued `namespacePrefix` is handled in OpentsdbEmitterConfig. Co-authored-by: Martin Gerholm <inspector-martin@users.noreply.github.com>
3.3 KiB
3.3 KiB
| id | title |
|---|---|
| opentsdb-emitter | OpenTSDB Emitter |
To use this Apache Druid extension, make sure to include opentsdb-emitter extension.
Introduction
This extension emits druid metrics to OpenTSDB over HTTP (Using Jersey client). And this emitter only emits service metric events to OpenTSDB (See Druid metrics for a list of metrics).
Configuration
All the configuration parameters for the OpenTSDB emitter are under druid.emitter.opentsdb.
| property | description | required? | default |
|---|---|---|---|
druid.emitter.opentsdb.host |
The host of the OpenTSDB server. | yes | none |
druid.emitter.opentsdb.port |
The port of the OpenTSDB server. | yes | none |
druid.emitter.opentsdb.connectionTimeout |
Jersey client connection timeout(in milliseconds). |
no | 2000 |
druid.emitter.opentsdb.readTimeout |
Jersey client read timeout(in milliseconds). |
no | 2000 |
druid.emitter.opentsdb.flushThreshold |
Queue flushing threshold.(Events will be sent as one batch) | no | 100 |
druid.emitter.opentsdb.maxQueueSize |
Maximum size of the queue used to buffer events. | no | 1000 |
druid.emitter.opentsdb.consumeDelay |
Queue consuming delay(in milliseconds). Actually, we use ScheduledExecutorService to schedule consuming events, so this consumeDelay means the delay between the termination of one execution and the commencement of the next. If your druid processes produce metric events fast, then you should decrease this consumeDelay or increase the maxQueueSize. |
no | 10000 |
druid.emitter.opentsdb.metricMapPath |
JSON file defining the desired metrics and dimensions for every Druid metric | no | ./src/main/resources/defaultMetrics.json |
druid.emitter.opentsdb.namespacePrefix |
Optional (string) prefix for metric names, for example the default metric name query.count with a namespacePrefix set to druid would be emitted as druid.query.count |
no | null |
Druid to OpenTSDB Event Converter
The OpenTSDB emitter will send only the desired metrics and dimensions which is defined in a JSON file.
If the user does not specify their own JSON file, a default file is used. All metrics are expected to be configured in the JSON file. Metrics which are not configured will be logged.
Desired metrics and dimensions is organized using the following schema:<druid metric name> : [ <dimension list> ]
e.g.
"query/time": [
"dataSource",
"type"
]
For most use-cases, the default configuration is sufficient.