From bf6fe234b213c7c059e40c71fc18c1d197a12e3b Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Thu, 10 Oct 2019 02:09:01 +0300 Subject: [PATCH] README.md: mention about `delete_series` handler Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/207 --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9689a7066..6ff1d6293 100644 --- a/README.md +++ b/README.md @@ -111,13 +111,13 @@ Ports may be altered by setting `-httpListenAddr` on the corresponding nodes. ### URL format -* URLs for data ingestion: `/insert//`, where: +* URLs for data ingestion: `http://:8480/insert//`, where: - `` is an arbitrary number identifying namespace for data ingestion (aka tenant) - `` may have the following values: - `prometheus` - for inserting data with [Prometheus remote write API](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_write) - `influx/write` or `influx/api/v2/write` - for inserting data with [Influx line protocol](https://docs.influxdata.com/influxdb/v1.7/write_protocols/line_protocol_tutorial/) -* URLs for querying: `/select//prometheus/`, where: +* URLs for querying: `http://:8481/select//prometheus/`, where: - `` is an arbitrary number identifying data namespace for the query (aka tenant) - `` may have the following values: - `api/v1/query` - performs [PromQL instant query](https://prometheus.io/docs/prometheus/latest/querying/api/#instant-queries) @@ -128,6 +128,10 @@ Ports may be altered by setting `-httpListenAddr` on the corresponding nodes. - `federate` - returns [federated metrics](https://prometheus.io/docs/prometheus/latest/federation/) - `api/v1/export` - exports raw data. See [this article](https://medium.com/@valyala/analyzing-prometheus-data-with-external-tools-5f3e5e147639) for details +* URL for time series deletion: `http://:8481/delete//prometheus/api/v1/admin/tsdb/delete_series?match[]=`. + Note that the `delete_series` handler should be used only in exceptional cases such as deletion of accidentally ingested incorrect time series. It shouldn't + be used on a regular basis, since it carries non-zero overhead. + * `vmstorage` nodes provide the following HTTP endpoints on `8482` port: - `/snapshot/create` - create [instant snapshot](https://medium.com/@valyala/how-victoriametrics-makes-instant-snapshots-for-multi-terabyte-time-series-data-e1f3fb0e0282), which can be used for backups in background. Snapshots are created in `/snapshots` folder, where `` is the corresponding