Howie
7c3d43fa7f
fix: docs ( #2658 )
...
Signed-off-by: lihaowei <haoweili35@gmail.com>
2022-05-30 08:16:07 +02:00
Roman Khavronenko
113301308a
vmalert: mention how to build a custom image ( #2626 )
...
Thanks to @f41gh7
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2022-05-23 00:59:34 +02:00
Aliaksandr Valialkin
1731fe2ada
docs: update the description for command-line flags according to recent changes
2022-05-20 15:09:43 +03:00
Yurii Kravets
5c42c1218a
Update vmalert.md ( #2580 )
...
docs: update vmalert/README.md
Co-authored-by: Roman Khavronenko <roman@victoriametrics.com>
2022-05-17 14:14:18 +02:00
Roman Khavronenko
284bda8746
docs: fix liquid syntax errors ( #2592 )
...
For liquid text processor double braces `{{` `}}`
are special chars for templating.
Since we use them in some of our docs with different purpose,
we must escape them to avoid syntax errors from liquid.
For escaping curly braces we use bult-in plugin which helps
to enclose sections of text via `{% raw %}` and `{% endraw %}`.
This approach prevents liquid syntax errors and makes render correct.
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2022-05-16 09:27:19 +02:00
Roman Khavronenko
0d07166eed
vmalert: fix readme formatting ( #2587 )
...
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2022-05-14 19:29:09 +02:00
Roman Khavronenko
9bc03f6b04
vmalert: follow-up after 0ac1cdfff5 ( #2586 )
...
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2022-05-14 18:56:31 +02:00
Andrii Chubatiuk
a531a96193
added reusable templates support ( #2532 )
...
Signed-off-by: Andrii Chubatiuk <andrew.chubatiuk@gmail.com>
2022-05-14 11:38:44 +02:00
Aliaksandr Valialkin
2c4565bb3d
docs/Cluster-VictoriaMetrics.md: move here the deduplication docs related to cluster version
2022-05-02 15:53:34 +03:00
Aliaksandr Valialkin
1097ebebe6
lib/httpserver: clarify that -tls flag enables TLS for http requests to -httpListenAddr
2022-04-16 16:59:26 +03:00
Aliaksandr Valialkin
b49b8020d6
docs: sync docs with the latest changes
2022-04-16 15:59:53 +03:00
Roman Khavronenko
45fcaa33e8
vmalert: add DNS service discovery ( #2465 )
...
https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2460
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2022-04-13 11:50:26 +03:00
Aliaksandr Valialkin
b89e846ce3
docs/CHANGELOG.md: document ed364a42e3
2022-04-11 12:11:32 +03:00
Roman Khavronenko
70bb0d2708
vmalert: add flag for disabling long-lived connections (keepalive) ( #2395 )
...
The new flag `datasource.disableKeepAlive` allows disabling keepalive
connections. This may be useful if there are multiple datasource
replicas (e.g. vmselects) behind the HTTP balancer to avoid uneven
load spread because of long-lived connections.
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2022-04-04 12:59:04 +03:00
Roman Khavronenko
56de8f0356
docs: fix typo in vmalert's API ( #2380 )
...
The API handler was changed in 1.75 but docs
still contain the old address.
https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2366
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2022-03-28 12:07:02 +02:00
Arash Hatami
a8de1ab000
A good change for MD files ( #2353 )
...
* Lint YAML
* Remove extra comment
* Fix command problem
* Format MD files
* Format & fix problem of MD files for docs
* Another fix for MD files
2022-03-22 13:40:55 +02:00
Aliaksandr Valialkin
09c6c7350b
docs/vmalert.md: sync after 11ae1ae924
2022-03-17 20:17:40 +02:00
Aliaksandr Valialkin
e03e46af4e
docs: make docs-sync
2022-03-16 12:30:02 +02:00
Roman Khavronenko
0fa7effc4b
docs: fix broken links ( #2303 )
...
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2022-03-13 15:56:01 +02:00
Dmytro Kozlov
565bd08c43
Issue-1824: added flags and different auth types support ( #2287 )
...
* vmalert/notifier: added flags and different auth types support
Co-authored-by: hagen1778 <roman@victoriametrics.com>
2022-03-10 13:09:12 +02:00
Bastien Dronneau
8b21f40217
docs(vmalert): typo in path ( #2278 )
2022-03-05 22:35:10 +02:00
Denys Holius
1685e181ae
Added minimal supported version of AlertManager ( #2237 )
...
* added minimal supported version of supported AlertManager
* docs: `make docs-sync`
Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-02-22 20:07:04 +02:00
Aliaksandr Valialkin
ee5da826e9
docs: update -help output for VictoriaMetrics components
2022-02-15 21:08:22 +02:00
Aliaksandr Valialkin
9bb60ab00f
lib/promscrape: set -promscrape.config.strictParse to true by default
...
This allows detecting long-living silent errors in -promscrape.config
2022-02-08 15:41:43 +02:00
Aliaksandr Valialkin
ba1b3b8ef2
docs: cross-link downsampling docs from deduplication and vmalert docs
2022-02-04 11:57:05 +02:00
Aliaksandr Valialkin
6530bcedec
docs: updates after 5da71eb685
...
* Mention about the ability to configure vmalert notifiers via files in docs/CHANGELOG.md
* Mention about the ability to use Consul service discovery for vmalert notifiers in docs/CHANGELOG.md
* Run `make docs-sync` in order to sync app/vmalert/README.md to docs/vmalert.md
2022-02-02 23:26:18 +02:00
Denys Holius
ae89b4e818
Old links replaced for newest ( #2033 )
...
* replaced old links to the website
* fixed deletion main README.md file
* fix: added docs files after docs-sync
2022-01-05 16:30:13 +02:00
Aliaksandr Valialkin
06642d97f5
app: allow specifying http and https urls in the following command-line flags
...
* -promscrape.config
* -relabelConfig
* -remoteWrite.relabelConfig
* -remoteWrite.urlRelabelConfig
2021-12-03 00:10:02 +02:00
Roman Khavronenko
d052c8c81e
vmalert: adjust topologies docs in README ( #1893 )
...
Commit changes images width and order in topologies section
for better readability.
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2021-12-02 11:27:46 +03:00
Roman Khavronenko
866b6a842b
Vmalert docs upd ( #1890 )
...
* vmalert: add topology examples in docs
* vmalert: docs typo fix
2021-12-01 18:33:06 +03:00
Aliaksandr Valialkin
10bd8b1d86
docs/CHANGELOG.md: document 852a895b70
2021-11-30 01:22:37 +02:00
Florian Klink
d8c70903ec
docs/vmalert.md: document vmalert url flags a bit more cleanly ( #1823 )
...
Describe remoteWrite.url is used to persist rules and alerts state info,
and add an additional paragraph explaining the separation between
-remoteRead.url and -datasource.url.
Fixes #1810 .
2021-11-17 00:54:06 +02:00
Aliaksandr Valialkin
5046efb94b
docs/vmalert.md: improve wording in Multitenancy chapter
2021-11-09 14:19:52 +02:00
Aliaksandr Valialkin
a67518fc6d
docs: mention that graphs on the official dashboards contain useful hints
2021-11-08 19:54:10 +02:00
João Paulo
47d1612bf8
docs: fix multiple typos ( #1787 )
...
Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2021-11-05 20:44:02 +02:00
Aliaksandr Valialkin
237885e0d2
docs/vmalert.md: document the addition of -defaultTenant.prometheus and -defaultTenant.graphite command-line options to enterprise version of vmalert
2021-11-05 20:04:09 +02:00
Aliaksandr Valialkin
bf814320b0
app/vmalert: remove rule.type config, since it doesnt play well with the upcoming default tenants for -clusterMode
...
It is better from the consistency point of view to set up rule types at group level where tenant config is set up.
2021-11-05 19:52:32 +02:00
Yury Molodov
a3e09a57c2
vmui: features ( #1711 )
...
* feat: initial uPlot graph
* feat: add zoom/pan for graph
* fix: add zoom by ctrl/mac
* fix: remove unused code
* feat: add toggle cache for fetch
* feat: add fix y-axis limits
* fix: stop point events while panning
* fix: change getting cursor position when scaling
* feat: add cursor tooltip to graph
* fix: uninstall chart.js
* fix: change link for create an issue
* fix: set default cache value to true
* app/vmalert: follow-up after 0e2486df565416e18007
2021-10-18 15:16:57 +03:00
Alexander Rickardsson
0e2486df56
vmalert: add disablePathAppend to remote read ( #1712 )
...
* vmalert: add disablePathAppend to remoteRead
* docs: add docs for remoteRead.disablePathAppend
2021-10-18 10:24:52 +03:00
Aliaksandr Valialkin
3e1683756b
docs/vmalert.md: follow-up after 68721f6e7d
...
Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1608
2021-09-14 14:47:47 +03:00
Aliaksandr Valialkin
c4f11a49f8
docs/CHANGELOG.md: document 5494bc02a6
2021-09-13 17:11:23 +03:00
Aliaksandr Valialkin
cfed015bb6
docs/vmalert.md: typo fix in Multitenancy chapter
2021-09-10 17:57:14 +03:00
Aliaksandr Valialkin
3a827b98cd
docs/vmalert.md: make docs-sync after 21f022e5f0
2021-09-09 16:16:25 +03:00
Aliaksandr Valialkin
111ea89a7d
docs: make docs-sync
2021-09-01 12:02:34 +03:00
Nikolay
7c70dcbe3b
adds external_labels per group for vmalert ( #1485 )
...
* adds external_label per group for vmalert
https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1471
2021-08-31 14:52:34 +03:00
Aliaksandr Valialkin
2288e75f03
docs/vmalert.md: run make docs-sync after 9ee3d0378f
2021-08-21 20:24:56 +03:00
Aliaksandr Valialkin
90434ba25b
app/vmalert: mention -remoteWrite.disablePathAppend in the description for -remoteWrite.url
2021-08-16 15:22:47 +03:00
Aliaksandr Valialkin
f37b963619
app/vmalert: follow-up for 2400f85761
2021-08-16 15:20:22 +03:00
Alexander Rickardsson
2400f85761
vmalert: enable configuring explicit path ( #1536 )
...
* vmalert: allow to disable automatically added path to remote write address via disablePathAppend flag
* docs: update docs to include remoteWrite.disablePathAppend
2021-08-16 14:20:57 +03:00
Aliaksandr Valialkin
d375d9b878
lib/envflag: add a link to docs for -envflag.enable
2021-08-11 10:29:33 +03:00
Aliaksandr Valialkin
c5f0b454f0
app/vmselect: follow-up after aa11ef6d3b
...
Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1413
2021-07-07 17:43:35 +03:00
Aliaksandr Valialkin
8a519f1518
docs/vmalert.md: follow-up after 6d5a8c28cd
2021-06-14 11:37:26 +03:00
Aliaksandr Valialkin
ab15bf8c90
docs: document rules replay feature for vmalert
...
Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/836
This is a follow-up for 2a259ef5e7
2021-06-09 12:27:34 +03:00
Aliaksandr Valialkin
eda6ee40b6
docs: make docs-sync after 2bbb1cc7c1
2021-05-26 12:32:16 +03:00
Aliaksandr Valialkin
b1e8d92577
docs/vmalert.md: sync with app/vmalert/README.md via make docs-sync
2021-05-24 15:47:20 +03:00
Aliaksandr Valialkin
f4719889da
lib/httpserver: typo fix in -http.shutdownDelay command-line flag description: servier -> server
2021-05-18 16:26:16 +03:00
Aliaksandr Valialkin
b30925738b
docs/vmalert.md: document multitenant support
...
https://github.com/VictoriaMetrics/VictoriaMetrics/issues/740
2021-05-18 16:26:14 +03:00
Aliaksandr Valialkin
6c944b86d8
docs: dealay -> delay
...
Thanks to @jelmd . See 0b7e3510c8 (r50884991)
2021-05-18 01:07:52 +03:00
Aliaksandr Valialkin
229d9d6dd7
docs/CHANGELOG.md: document -datasource.roundDigits added at 5c448126dc
2021-05-10 11:18:26 +03:00
Aliaksandr Valialkin
508f500477
docs/vmalert.md: update docs after afca7b430c
2021-04-30 11:49:01 +03:00
Aliaksandr Valialkin
6bc52fe41a
all: rename https://victoriametrics.github.io to https://docs.victoriametrics.com
2021-04-20 20:16:17 +03:00
Aliaksandr Valialkin
5720b283fa
all: consistency renaming Victoria Metrics -> VictoriaMetrics
...
VMInsert -> vminsert
VMSelect -> vmselect
VMStorage -> vmstorage
2021-04-20 11:45:48 +03:00
Aliaksandr Valialkin
663a91bb82
docs: update -help output after the commit 77be3e3a82
2021-04-12 12:34:59 +03:00
Roman Khavronenko
7644efae01
Docs update ( #1199 )
...
* docs: drop table of contents for `vmctl`
We already have it autogenerated on .github.io, so no need to keep it.
* docs: mention OpenTSDB migration feature for vmctl
* docs: sync docs for `vmalert`
2021-04-10 15:46:08 +03:00
Roman Khavronenko
c6a8ebb11f
docs: update docs ordering and formatting ( #1192 )
...
The major change is adding `sort` directive to docs. For those docs which are copied
from internal packages `sort` is added via makefile command. For the rest it is added
manually since they're updated manually as well.
The rest of changes is connected with markdown formatting. For example, changing headers
in some files (`##` => `#`) makes navigation on .github.io to look better. This especially
useful for `changelog` docs.
Table of contents for `vmctl` is dropped, since we already have it autogenerated on .github.io.
No link changes expected. The corresponding PR to `cluster` branch will be made in follow-up PR.
2021-04-07 13:39:16 +03:00
Aliaksandr Valialkin
1db1a29ffa
all: increase minimum supported Go version for building VictoriaMetrics components from v1.14 to v1.15
...
This is needed after the commit c0ac740f93https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1147
2021-03-29 23:04:53 +03:00
Aliaksandr Valialkin
f6529f932a
docs: add a link to the repository from build instruction for all the VictoriaMetrics components
2021-03-25 17:14:42 +02:00
Aliaksandr Valialkin
c3c3e51f17
docs/vmalert.md: remove misleading -evaluationInterval=3s from example config args
...
3s evaluation interval is too small for practical setups. It can result in increased load on datasource.
So it is better to remove it from example config args, which are usually copy-pasted by novice users.
2021-03-25 15:29:06 +02:00
Aliaksandr Valialkin
85a95bf60c
all: various fixes in command-line flag descriptions
2021-03-15 21:59:25 +02:00
Ihor Borodin
d212f35ae8
Fixing examples of external.alert.source in documentation ( #1120 )
...
* Fixing examples of external.alert.source in documentation
2021-03-09 20:49:50 +00:00
Aliaksandr Valialkin
201b685b13
all: bump minimum supported Go version from 1.13 to 1.14
2021-03-03 15:57:13 +02:00
Alexandros Orfanos
f4f8f21875
vmalert: docs update - status endpoint needs group ID, not group name ( #1106 )
2021-03-03 07:46:10 +00:00
Aliaksandr Valialkin
baefe5a8ad
docs: actualize -help output
2021-03-01 17:01:27 +02:00
Roman Khavronenko
2ff038d841
vmalert: mention -datasource.appendTypePrefix in README ( #1052 )
2021-02-03 23:44:37 +02:00
Aliaksandr Valialkin
a2344ef4b7
docs/vmalert.md: mention that type option can be set at group level additionally to rule level
2021-02-03 21:13:13 +02:00
Aliaksandr Valialkin
5d87dbfd65
docs: document ability to query Graphite datasource from vmalert
2021-02-01 15:26:33 +02:00
Nikolay
1de15ad490
adds escape for CRLF ( #984 )
...
at external.alert.source - \n and \r symbols was url encoded, instead of direct usage.
replace it from "\n" to `\n` allows to skip url encoding.
https://github.com/VictoriaMetrics/VictoriaMetrics/issues/890
2020-12-25 11:03:13 +02:00
Aliaksandr Valialkin
0326638c90
app/vmalert: typo fix in descriptions for notifier.basicAuth.username and notifier.basicAuth.password command-line flags
2020-12-24 12:48:59 +02:00
Aliaksandr Valialkin
9df60518bb
docs: mention that it is possible to set multiple -notifier.tlsInsecureSkipVerify command-line flags for vmalert
...
See c3a92968343c2b3619f1ab935702d0e9b3a46733
2020-12-22 22:32:13 +02:00
Aliaksandr Valialkin
1eabbc0e27
docs/vmagent.md: mention that sample_limit option has no sense when stream parsing is enabled
2020-12-15 18:43:41 +02:00
Aliaksandr Valialkin
9d42546a27
docs: consistently use links to https://victoriametrics.github.io for documentation references
2020-12-11 21:08:18 +02:00
Aliaksandr Valialkin
590d8d537f
docs/vmalert.md: make docs-sync
2020-10-13 18:34:32 +03:00
Aliaksandr Valialkin
d25dd7fdb6
docs: make docs-sync
2020-09-30 09:50:29 +03:00
Aliaksandr Valialkin
f6f5c4118c
docs: make docs-sync
2020-09-21 21:47:47 +03:00
Aliaksandr Valialkin
d7c04db1fc
docs: sync docs for vmalert, vmauth, vmbackup and vmrestore
2020-09-09 21:10:34 +03:00
Aliaksandr Valialkin
de6970e828
docs/vmalert.md: sync with app/vmalert/README.md via make docs-update
2020-08-28 09:51:48 +03:00
Aliaksandr Valialkin
184670fb9b
docs: update docs
2020-08-14 19:13:42 +03:00
Aliaksandr Valialkin
3f498cf2dc
docs/{vmagent,vmalert}: add instruction on how to build for ARM
2020-07-31 09:25:22 +03:00
Aliaksandr Valialkin
e255c066cc
docs/vmalert.md: sync with app/vmalert/README.md
2020-07-30 21:56:48 +03:00
Aliaksandr Valialkin
63e5ee0d29
docs: sync with upstream
2020-06-29 22:09:03 +03:00
Aliaksandr Valialkin
e65b4cb6b1
docs/vmalert.md: sync with app/vmalert/README.md
2020-06-23 22:49:38 +03:00
Aliaksandr Valialkin
818abca8f1
make docs-sync
2020-06-18 23:55:28 +03:00
Aliaksandr Valialkin
e53ee763f9
docs/vmalert.md: sync with app/vmalert/README.md
2020-06-10 19:38:24 +03:00
Aliaksandr Valialkin
f7ff809c1e
docs/vmalert.md: sync with app/vmalert/README.md via make docs-sync
2020-06-02 19:15:15 +03:00
Aliaksandr Valialkin
ab8f5545bc
docs/vmalert.md: sync with app/vmalert/README.md
2020-05-15 13:27:09 +03:00
Aliaksandr Valialkin
21598ac417
docs/vmalert.md: sync with app/vmalert/README.md
2020-05-13 22:55:35 +03:00
Aliaksandr Valialkin
1aea001532
docs/vmalert.md: sync with app/vmalert/README.md
2020-05-05 07:50:57 +03:00
Aliaksandr Valialkin
d0ebbb166e
docs: add vmalert.md
2020-04-29 17:42:06 +03:00
