Commit graph

47 commits

Author SHA1 Message Date
Ben Kochie
5ff2356e36
Mention automatic reloading in the README.
Signed-off-by: Ben Kochie <superq@gmail.com>
2019-01-24 08:26:45 +01:00
dongwenjuan
d655643a58 fix the format of code-block in README
Signed-off-by: dongwenjuan <dong.wenjuan@zte.com.cn>
2018-12-27 11:35:02 +08:00
Matthias Rampke
cd3a546179
Clarify TTLs configuration remark
I realized that "TTLs are applied" is ambiguous. Metrics don't only
expire on receiving a sample, so mention that this is about the
configuration.

Signed-off-by: Matthias Rampke <mr@soundcloud.com>
2018-12-20 16:47:22 +00:00
Ivan Mikheykin
331d2a56d0 Language fixes in README, reduce map lookups in saveLabelValues.
Signed-off-by: Ivan Mikheykin <ivan.mikheykin@flant.com>
2018-12-19 08:24:17 +03:00
Ivan Mikheykin
d1b2dd47a8 TTL expiration tests, README update
Signed-off-by: Ivan Mikheykin <ivan.mikheykin@flant.com>
2018-12-18 09:46:05 +03:00
Matthias Rampke
761e64df10
Copy-edits in README
straightening out some wording, and fixing unquoted `*`.

Signed-off-by: Matthias Rampke <mr@soundcloud.com>
2018-10-10 21:18:00 +00:00
Wangchong Zhou
4d9ce8c70a
add readmes
Signed-off-by: Wangchong Zhou <fffonion@gmail.com>
2018-10-04 10:55:33 -07:00
gaurav
3ba10e2cb5 Fixed docker run command for:
1. Configuration file extension changed from .conf to .yml
2. Added missing dash (-) in statsd-exporter inputs

Signed-off-by: gaurav <gbahrani@gmail.com>
2018-09-07 11:44:28 +00:00
Matthias Rampke
95d60eed01
Add a note about flag conventions
this note can be removed in half a year or so.

Fixes #147.

Signed-off-by: Matthias Rampke <mr@soundcloud.com>
2018-08-28 08:08:46 +00:00
Matthias Rampke
3a6b6ce5d5
Update the README for #141
it has a copy of the usage

Signed-off-by: Matthias Rampke <mr@soundcloud.com>
2018-08-21 08:57:44 +00:00
Matthias Rampke
8d1a9e0330
Break the quantile documentation into a summary-specific paragraph
to untangle the summary and histogram configuration, give an explicit
example of a summary match.

Signed-off-by: Matthias Rampke <mr@soundcloud.com>
2018-08-09 08:18:39 +00:00
Harry Bagdi
a144b1f9f7 feat: configurable quantiles for Summaries
* Quantile values for a Summary are now configurable.

* The default quantiles (DefObjectives) in the prometheus Go client library is
deprecated. This commit removes the reliance on it.

Signed-off-by: Harry Bagdi <harrybagdi@gmail.com>
2018-08-08 19:41:41 -07:00
Simon Westphahl
b2423c56a5 Update readme regarding metric type matching
Co-authored-by: Simon Westphahl <westphahl@gmail.com>
Signed-off-by: Simon Westphahl <simon.westphahl@bmw.de>
2018-06-15 14:26:47 +02:00
Tobias Schmidt
c11d1e9cf2 Use _total suffix for counters
According to the project's naming best practices[0], the suffix to
indicate a counter type is called `_total`.

[0]: https://prometheus.io/docs/practices/naming/
2018-01-18 00:48:42 +01:00
Matthias Rampke
8608d9db40
Fix double-plural 2018-01-17 17:09:16 +00:00
Erick Pintor
f058f3aa33 document metric name and labels names unique set 2018-01-17 14:34:33 -02:00
Erick Pintor
515ae0ee89 document metric name templating for regex matches 2018-01-17 14:30:40 -02:00
Erick Pintor
27ee4050c4 allow for dynamic metric name 2018-01-16 18:45:55 -02:00
Brian Akins
6738c909a5 Add drop action for matches 2018-01-02 17:21:50 -05:00
Matthias Rampke
a794d58413
Fix incorrect --help output in README
This removes the not actually available log flags from the README. We
should really have those (#111), but at least it's less confusing this
way.

Fixes #110.
2017-11-29 14:20:24 +00:00
Brian Akins
e58bf8e1ca Set name in mapping, rather than from special label with key 'name' 2017-11-13 07:23:14 -05:00
Matthias Rampke
0ac908603a Update documentation of metric name escaping.
The escaping changed in 728bdc52ae, before
0.1.0. Add a test for the escape function, and test various cases,
including those mentioned in the README.

This reveals that the README is inaccurate, adjust it to what has been
the reality for many years. Fixes #97.
2017-11-10 20:34:10 +00:00
Matthias Rampke
6c04ec1d89 Fix mapping example in the README
Strings with leading asterisks need to be escaped in YAML.

Add the same examples into the test suite to make sure they do what we
claim they do.

Fixes #102.
2017-11-10 20:19:41 +00:00
Dave Rawks
ab2a88c06f Allow help text to be customized (#87)
* Updated mappings to accept custom help text in YAML config
* Updated exporter to display configured help messages
* Update README to reflect aditional configurability
* Removed inaccurate comment

* Removed some cruft from a rebase
2017-10-04 18:11:58 +02:00
Ben Kochie
9accf494a9 Merge pull request #98 from drawks/remove_legacy_mapper
Removes support for legacy mapper config
2017-09-29 10:08:08 +02:00
Dave Rawks
ec3cc120e2 Resolves #84 adds support for regex mappers (#85)
* Added `regex` match_type as valid config callout in both individual mappers
    and mapper defaults
  * Added test coverage for changes
  * Updated documentation to reflect usage of `match_type` parameter and
    provide example of a raw regex match rule
2017-09-29 09:57:17 +02:00
Dave Rawks
0478c40ab0 Removes -statsd.add-suffix option flag
* Remove option flag
* Update NewExporter call signature to not take suffix boolean
* Update tests to reflect new behavior and signature
* Update documentation to reflect option flag removal
2017-09-28 11:30:17 -07:00
Dave Rawks
892b725faf Removes support for legacy mapper config
* Removed legacy mapper config parser
  * Removed logic to switch to YAML parsing based on mapping filename
  * Removed tests for legacy mapper config
  * Remove references to legacy mapper config format from `README.md`
2017-09-28 11:11:26 -07:00
Julius Volz
aeab2905ad Merge pull request #66 from bakins/extended-config
Allow histograms for timer metrics
2017-08-03 17:25:30 +02:00
jwfang
bbdbb9a050 update README for tcp listener, fix #75 2017-08-02 13:22:28 +08:00
Brian Akins
9bca336876 Simple YAML configuration docs 2017-08-01 07:26:44 -04:00
Jason Mooberry
5018c7415a Allow comments in mapping files 2017-05-23 18:12:17 -04:00
Johannes 'fish' Ziemke
cdeb0c9743 Use promu/docker/circleci based release process 2016-05-03 23:08:02 +02:00
Johannes 'fish' Ziemke
8e43fc2654 Merge pull request #37 from prometheus/fish/remove-auto-suffixes
Make metric suffixes optional, expose unmapped events
2016-05-03 09:46:59 -07:00
Ilya Margolin
0b792e0be6 DogStatsD: review changes 2016-05-03 18:28:33 +02:00
Johannes 'fish' Ziemke
f031e30721 Add flag to disable metric type suffixes 2016-05-03 01:16:34 +02:00
Mathias Methner
dc0ab29c33 fix documentation for docker udp port publishing 2016-02-01 16:54:59 +01:00
Mac Browning
ea7341a6c4 rename bridge -> exporter 2015-10-09 20:34:28 -04:00
Steve Durrheimer
395c1422e5 Add Docker instructions to the README 2015-07-11 13:22:06 +02:00
Julius Volz
143288bf07 Document use-case without any StatsD server.
Fixes https://github.com/prometheus/statsd_bridge/issues/15
2015-06-18 14:24:46 +02:00
Brian Brazil
a054446e2f Correct example, need to specify variables like in bash.
See http://golang.org/pkg/regexp/#Regexp.Expand
2015-04-16 23:35:46 +01:00
Julius Volz
729bdfeef7 Update usage flags in README.md. 2015-03-23 13:45:29 +01:00
juliusv
fe0359ec09 Update README.md 2013-07-06 00:32:52 +02:00
juliusv
9cee127f0d Wrap README.md lines 2013-07-05 23:51:30 +02:00
juliusv
a3dfea3958 Update README.md 2013-07-05 23:49:05 +02:00
juliusv
fc78bc553d Update README.md 2013-07-05 23:45:20 +02:00
juliusv
8614367958 Create README.md 2013-07-02 18:29:40 +02:00