Commit graph

97 commits

Author SHA1 Message Date
Matthias Rampke 29c77f407c
Remove --help output from README
I have no idea if it is even up to date. The README file was too large to fit
Docker Hub's limitations; this removal brings us just under the [25KB
limit](https://github.com/docker/hub-feedback/issues/238).

Signed-off-by: Matthias Rampke <matthias@prometheus.io>
2024-03-22 15:52:23 +00:00
Matthias Rampke 2c7fd1edd4
Release 0.26.0
with documentation for #521 and changelog.

Signed-off-by: Matthias Rampke <matthias@prometheus.io>
2023-12-06 09:52:31 +00:00
Eddie Bracho 61f201130e document scale parameter
Signed-off-by: Eddie Bracho <eddiebracho@gmail.com>
2023-06-01 16:35:05 -07:00
Jun Ouyang e22a86f5f9 fix 4040 link
Signed-off-by: Jun Ouyang <ouyangjun1999@gmail.com>
2023-01-27 20:18:43 +08:00
Pedro Tanaka 559fc9c1af
Fixing error in example YAML
Signed-off-by: Pedro Tanaka <pedro.tanaka@shopify.com>
2022-12-06 09:51:45 +01:00
Pedro Tanaka 507b0a20dd
Adding docs for new options
Signed-off-by: Pedro Tanaka <pedro.tanaka@shopify.com>
2022-12-06 09:49:25 +01:00
Pedro Tanaka 6ef0b3b4e8 Changing issue number for tracking support for globbling
Signed-off-by: Pedro Tanaka <pedro.stanaka@gmail.com>
2022-06-29 10:23:33 +02:00
Pedro Tanaka 1a148215de Adding note about behavior of .+ regex
Signed-off-by: Pedro Tanaka <pedro.stanaka@gmail.com>
2022-06-29 10:22:12 +02:00
Pedro Tanaka f935a9c869 Adding documentation about special regex match group
Signed-off-by: Pedro Tanaka <pedro.stanaka@gmail.com>
2022-06-29 10:22:12 +02:00
Matthias Rampke f5c6a55c0d
Update transition scenarios
Recommend running the exporter as a sidecar, now that the relay feature
makes this easy.

Re-order the overview section to put the final state first, then explain
transition and try-out options.

Signed-off-by: Matthias Rampke <matthias@prometheus.io>
2021-09-01 15:59:07 +02:00
SuperQ 0b84893d4a
Add statsd relay
Add a simple statsd packet output relay that buffers and forwards raw
statsd lines.
* Only supports UDP output.
* Has a hard-coded buffering timeout of 1 second.

Closes: https://github.com/prometheus/statsd_exporter/issues/95

Signed-off-by: SuperQ <superq@gmail.com>
2021-09-01 15:14:01 +02:00
Matthias Rampke da69d725d0 Escape backslashes in regex examples
In double-quoted strings, the backslash is [special to YAML](http://blogs.perl.org/users/tinita/2018/03/strings-in-yaml---to-quote-or-not-to-quote.html).
Make sure that the examples do this correctly.
Fixes the wonky rendering on github.com.

Signed-off-by: Matthias Rampke <mr@soundcloud.com>
2021-03-23 17:05:56 +00:00
glightfoot 06411336c7 add support for setting histogram_options and summary_options in defaults
Signed-off-by: glightfoot <glightfoot@rsglab.com>
2021-01-28 13:58:52 -05:00
Matthias Rampke bade06f775
Clarify ordering more
Instead of saying what users should not do, provide a positive
recommendation.

Signed-off-by: Matthias Rampke <matthias@prometheus.io>
2021-01-22 12:55:37 +00:00
Matthias Rampke 64c79eea8b
Reorder and rework glob vs. regex documentation
Note that regular expression matches are only evaluated after glob
matches. Add headings and introductory sentences to each glob type.

Remove the technical reasoning for choosing glob vs. regex; instead
explain the performance implications and gotchas of each type in turn.

Closes #349.

Signed-off-by: Matthias Rampke <matthias@prometheus.io>
2020-12-18 09:24:47 +00:00
Daniel Sabsay 07c754c759 Minor documentation fixes
* Fix CLI help for --statsd.event-flush-interval
* Move verbiage regarding default histogram bucket values to proper
  section

Signed-off-by: Daniel Sabsay <sabsay@adobe.com>
2020-09-28 10:42:44 -07:00
Matthias Rampke a73707d102
Merge pull request #329 from glightfoot/reload-api
Add lifecycle api
2020-08-21 12:02:18 +02:00
glightfoot c162b349b7 add parsing flags to README
Signed-off-by: glightfoot <glightfoot@rsglab.com>
2020-08-10 14:55:57 -04:00
glightfoot 1293a24b59 add lifecycle api
Signed-off-by: glightfoot <glightfoot@rsglab.com>
2020-08-10 14:46:44 -04:00
glightfoot afa40f4ada rename cli flags for parsing and add docs to README
Signed-off-by: glightfoot <glightfoot@rsglab.com>
2020-08-10 12:56:23 -04:00
Matthias Rampke cc709f242c
Update changelog and readme for #315: SignalFX extension
Declare the behavior with mixed tagging as undefined, we don't want to
promise anything in that case, not even negatively.

Signed-off-by: Matthias Rampke <matthias@prometheus.io>
2020-06-26 15:18:04 +00:00
Matthias Rampke b64e07c7d9
Changelog and documentation update for #314
Update the README to reflect #314. Add an entry to the changelog
with extended compatibility notes.

Signed-off-by: Matthias Rampke <matthias@prometheus.io>
2020-06-19 11:56:55 +00:00
Matthias Rampke c8b8ddc952
Support checking configuration and exiting
If desired, go through all the motions of setting up the exporter, but
then exit. This is not very elegant, as we actually open the ports,
which may not be what you want to do in a pipeline, but it is the
quickest way to implement this.

Fixes #263.

Signed-off-by: Matthias Rampke <matthias@prometheus.io>
2020-05-29 08:51:41 +00:00
Matthias Rampke f6384291a6
Add notes about library usage to the README
specifically, deny compatibility guarantees, but do note that we
recognize the packages as reusable.

Signed-off-by: Matthias Rampke <mr@soundcloud.com>
2020-04-17 12:02:15 +00:00
Elliott Peay 828e12c345 Fixed typo
Signed-off-by: Elliott Peay <elliott.peay@gmail.com>
2020-04-11 16:14:11 -07:00
Matthias Rampke 37e54d0f47
Merge pull request #294 from aykutfarsak/patch-1
Fix Docker Hub URL
2020-03-05 10:56:57 +01:00
Matthias Rampke 2ad8989cd2
Add changelog & readme entries for #281
explain the tradeoffs for the cache strategies based on this comment:

https://github.com/prometheus/statsd_exporter/pull/281#issuecomment-573103251

Signed-off-by: Matthias Rampke <mr@soundcloud.com>
2020-03-05 09:35:37 +00:00
Aykut Farsak 9778828863 Fix Docker Hub URL
Signed-off-by: Aykut Farsak <aykutfarsak@gmail.com>
2020-03-05 08:35:15 +03:00
Thomas Gummerer dae5d782a6 allow setting granularity for summary metrics
The Go client for prometheus aggregates summary metrics over 10
minutes by default, in 5 buckets.  This is not always the behaviour we
want.

Allow tweaking those settings in `statsd_exporter`, so we can
aggregate summary metrics over more or less time, with more or fewer
buckets, and set the cap for the bucket as well.

Signed-off-by: Thomas Gummerer <t.gummerer@gmail.com>
2020-02-18 18:04:38 +00:00
Thomas Gummerer 80b77513a6 create sub-hierarchies for summary and histogram options
Currently the Buckets and Quantiles settings are top level settings per metric
in the yaml.  In a subsequent commit we're going to allow adding more such
options for summaries, at which point having them all at the top level gets
confusing.

Split the options out into separate hierarchies to allow adding more options,
without adding confusion.  We preserve backwards compatibility by still
accepting the old option, but warning when it is present.

Signed-off-by: Thomas Gummerer <t.gummerer@gmail.com>
2020-02-18 18:04:27 +00:00
Matthias Rampke d888f25cb6
Merge pull request #275 from ergo/patch-1
Fix format for dogstatsd tags
2019-12-09 12:47:00 +01:00
Marcin Lulek a1c201d821 Fix format for dogstatsd tags
Only key:value format for dogstatsd is accepted by latest version of statsd exporter.
I've tried both official client and bash scripts to send the data:

    echo "newpure.test:1|c|@0.5|#country:china" | nc -w 1 -u 127.0.0.1 9125` - will work
    echo "newpure.test:1|c|@0.5|#country=china" | nc -w 1 -u 127.0.0.1 9125 - will not work

Signed-off-by: Marcin Lulek <info@webreactor.eu>
2019-12-09 12:34:03 +01:00
abbasalizaidi 8ebffcfb93 Corrected spellings of the word policy
Signed-off-by: Abbas Ali Zaidi <abbasali.zaidi@fireeye.com>
2019-12-02 12:05:37 +05:30
Joaquín Fernández Campo 84657e85ec Updated docs and added good/bad example yaml
Signed-off-by: Joaquin Fernandez Campo <jfcampo@gmail.com>
2019-11-26 10:01:29 +01:00
Tony Wooster 0e000fe833 Drop metrics with mixed tagging styles
Signed-off-by: Tony Wooster <twooster@gmail.com>
2019-09-18 15:33:23 +02:00
Tony Wooster 22619bb8a9 Update README
Signed-off-by: Tony Wooster <twooster@gmail.com>
2019-09-17 17:01:34 +02:00
Tony Wooster 2933dd8ad0 Add support for Librato-style tags
Signed-off-by: Tony Wooster <twooster@gmail.com>
2019-09-14 17:14:03 +02:00
Amit Saha 8479e3d7a3 README - Add a note regarding unit conversions for timers
Signed-off-by: Amit Saha <amitsaha.in@gmail.com>
2019-09-06 09:46:17 +10:00
Amit Saha 4d518de467 Update use_ms note for dogstatsd client
Signed-off-by: Amit Saha <amitsaha.in@gmail.com>
2019-09-04 03:06:59 +10:00
Raghu Siddarth Udiyar d49afad05c Link to API documentation instead
Co-Authored-By: Matthias Rampke <mr@soundcloud.com>
Signed-off-by: Raghu Udiyar <raghusiddarth@gmail.com>
2019-08-02 14:55:01 +05:30
Raghu Udiyar b0a54e1d65 Add note about DogStatsD use_ms option
DogStatsD by default emits timer metric in seconds, while the exporter
assumes milliseconds; which is the default for statsd. The `use_ms` option
fixes this, and will be useful for dogstatsd users to know.

Signed-off-by: Raghu Udiyar <raghusiddarth@gmail.com>
2019-08-01 15:55:46 +05:30
Matthias Rampke f72f25f8ce
Merge pull request #244 from prometheus/mr/quote-yaml
Quote all matchers in YAML examples
2019-07-05 16:28:18 +02:00
Matthias Rampke 64a51731f7
Quote all matchers in YAML examples
They can start with a * which makes YAML barf if not quoted. Instead of
figuring out individually what does and does not need to be quoted,
always quote.

Signed-off-by: Matthias Rampke <mr@soundcloud.com>
2019-07-05 13:32:22 +00:00
Matthias Rampke 23ef5daeac
Reload on SIGHUP instead of watching the file
This is more portable (works on any system that has UNIX signals) and
removes the dependency on fsnotify, which doesn't compile on AIX. It
also reduces the probability of failed reloads due to partial writes.

Fixes #241.

Signed-off-by: Matthias Rampke <mr@soundcloud.com>
2019-07-05 13:30:31 +00:00
golopot 5cea0077e4 Update links for DogStatsD in README.md
Signed-off-by: Chiawen Chen <golopot@gmail.com>
2019-06-11 19:22:43 +08:00
Clayton O'Neill c7e76967c8
Add internal event queuing and flushing
At high traffic levels, the locking around sending on channels can cause
a large amount of blocking and CPU usage.  These adds an event queue
mechanism so that events are queued for short period of time, and
flushed in batches to the main exporter goroutine periodically.

The default is is to flush every 1000 events, or every 200ms, whichever
happens first.

Signed-off-by: Clayton O'Neill <claytono@github.com>
2019-06-04 06:57:48 -04:00
Matthias Rampke 698bcdf8c3
Merge pull request #198 from SpencerMalone/mapping-cache
Adding mapping cache
2019-05-15 13:05:00 +00:00
Clayton O'Neill 04bba78d61
Add support for Datadog distribution type
This adds the ability to accept Datadog's distribution type and treat it
like a histogram/summary.

Signed-off-by: Clayton O'Neill <claytono@github.com>
2019-05-13 14:59:21 -04:00
SpencerMalone 35d1a99592 Adding mapping cache
Signed-off-by: SpencerMalone <malone.spencer@gmail.com>
2019-04-26 18:00:39 -04:00
Matthias Rampke ee653990e6
Update changelog and README for #199
Signed-off-by: Matthias Rampke <mr@soundcloud.com>
2019-04-23 08:47:32 +00:00