Aliaksandr Valialkin
adc69b872c
docs: run make docs-images-to-webp after 02a0a7f428
...
This reduces added image sizes by 3x
Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/5437
Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5370
2023-12-07 16:40:37 +02:00
Alexander Marshalov
02a0a7f428
added field version to the response for /api/v1/status/buildinfo API for using more efficient API in Grafana for receiving label values, added additional info about setup Grafana datasource ( #5370 ) ( #5437 )
2023-12-07 16:37:36 +02:00
Aliaksandr Valialkin
334a739ff6
docs: convert png images to webp in all the docs except of docs/operator/*
...
This reduces the size of docs/* folder from 33MB to 18MB
Images inside docs/operator/* must be converted at the https://github.com/VictoriaMetrics/operator/tree/master/docs
and then the updated images must be automatically propagated to the docs/operator/*
This is a follow-up for d3f919df3ehttps://github.com/VictoriaMetrics/VictoriaMetrics/pull/5206
2023-11-22 19:21:00 +02:00
Aliaksandr Valialkin
377627c4c9
deployment: update VictoriaMetrics tag from v1.93.1 to v1.93.2
...
See https://docs.victoriametrics.com/CHANGELOG.html#v1932
2023-09-01 17:35:48 +02:00
hagen1778
a20234d2d0
docs: fix typo for deduplication description in k8s guide
...
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-08-28 14:45:00 +02:00
Daria Karavaieva
278d3c20a4
vmanomaly guide docker compose run fix according licensing ( #4876 )
...
* docker-compose run fix according to licensing
* public v1.5.0 of vmanomaly
* new file list image
* 1.93.1 version of VM
2023-08-25 18:28:39 +02:00
hagen1778
1043fc1fd9
alerts: add docs section for the full list of alerting rules
...
The change also includes update of all references in other docs
to the alerting rules.
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-08-03 10:46:25 +02:00
Aliaksandr Valialkin
cc8427f11b
docs: use 1. instead of N. in numbered bullets, so they are automatically adjusted by Github Markdown engine
...
See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#lists
2023-07-26 14:39:44 -07:00
Zakhar Bessarab
4f340411b8
docs: fix broken link to managed VM ( #4679 )
...
Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com>
2023-07-20 17:00:36 +02:00
Artem Navoiev
8a4c89ea22
docs: change images from markdown tag to html for migration
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-05-29 07:11:15 -07:00
Roman Khavronenko
1c3f50f791
docs: mention multi-tenancy in docs ( #4357 )
...
The update should make understanding of multi-tenancy more clear
for influxdb users.
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2023-05-29 07:37:23 +02:00
Artem Navoiev
434358b551
remove absolute links, fix aliase
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-05-25 14:35:21 -07:00
Artem Navoiev
c1ad48edf9
fix title in multi-regional-setup-dedicated-regions.md
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-05-25 23:14:29 +02:00
Aliaksandr Valialkin
9fa052c302
deployment/docker: update VictoriaMetrics version from v1.90.0 to v1.91.0 in docker compose files
2023-05-18 15:34:21 -07:00
Alexander Marshalov
2e494e2375
fixed typos in documentation and commandline flags descriptions ( #4275 )
2023-05-10 09:50:41 +02:00
Artem Navoiev
5dde81259c
prepare operator docs to migration
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-05-01 12:32:58 +02:00
Alexander Marshalov
31e174977e
doc improvements ( #4172 ) ( #4186 )
...
- added info about metric `vm_vminsert_metrics_read_total`,
- small doc refactoring
- and added make-command for running docs in docker.
Signed-off-by: Alexander Marshalov <_@marshalov.org>
2023-04-24 13:38:00 +02:00
Aliaksandr Valialkin
9586dabd94
docs/guides: update VictoriaMetrics from v1.89.1 to v1.90.0
2023-04-06 19:07:38 -07:00
Artem Navoiev
33c6cc2530
fix closing divs in docs
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-04-04 13:00:22 +02:00
Daria Karavaieva
0945a03843
Vmanomaly guide index fix ( #4029 )
...
* name and scrutture change
* fix indexing
* index fix
* name change
* line separator fix
2023-03-29 20:24:06 +02:00
Daria Karavaieva
24938872a6
Vmanomaly guide ( #3834 )
...
Setting up VMAnomaly on NodeExporter metrics with VictoriaMetrics and AlertManager.
* vmanomaly-guide-draft
* aletr graphs and description
* readme vmanomaly tutorial
* Added back fit_every param for performance
* vmanomaly guide fixes
* added spaces div
* spaces + resize image
* alert example grammar
* quotation marks
* docker link
* typo fixed
* more links
* reader section rephrased
* label change
* lower case for grafana service
* lower case for vm service
* yaml markdown
---------
Co-authored-by: Dima Lazerka <dima@victoriametrics.com>
2023-03-23 21:04:44 +02:00
Zakhar Bessarab
ac3043ff74
doc/vmgateway-grafana-openid-guide: fix formatting, add reproducible example and example results ( #3964 )
2023-03-17 09:57:10 +01:00
Zakhar Bessarab
8f6d5217d1
doc: add guide for vmgateway configuration with OpenID and Grafana ( #3951 )
...
docs: add guide for vmgateway configuration with OpenID and Grafana
2023-03-14 16:19:29 +01:00
panguicai
21546e6922
docs: update operator release name to be consistent with the following ( #3845 )
...
Signed-off-by: panguicai008 <1121906548@qq.com>
2023-02-21 16:57:54 +01:00
Aliaksandr Valialkin
ef1ef0598b
docs/guides/migrate-from-influx.md: remove misleading doublequotes from the query example
2023-02-20 19:25:51 -08:00
Max Golionko
a2ba1f09e4
add guide to list of guides
2023-02-02 15:43:55 +02:00
Denys Holius
ffe6e6fe59
guides/guide-delete-or-replace-metrics.md: fixed wrong curl command ( #3652 )
2023-01-15 13:02:52 -08:00
Corporte Gadfly
f32a79189b
docs: fix typo ( #3648 )
2023-01-13 09:39:11 +01:00
Artem Navoiev
8b763175ff
Add Understand Your Setup Size Guide ( #3572 )
...
docs: add Understand Your Setup Size Guide
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-01-05 14:56:50 +01:00
Artem Navoiev
7d9c4bebc0
update links to grafana dashboards ( #3534 )
...
docs: update links to grafana dashboards
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2022-12-25 17:36:20 +01:00
Denys Holius
aebe21e2c8
guides/README.md: fix link to guide-delete-or-replace-metrics.html ( #3331 )
2022-11-09 12:00:46 +02:00
Aliaksandr Valialkin
4ef5fe1317
docs/guides/guide-vmcluster-multiple-retention-setup.md: clarify docs after a75d85b11e
2022-11-05 10:02:48 +02:00
Artem Navoiev
a75d85b11e
update multi-tenancy guide. Add infromation about Enterprise and Rete… ( #3285 )
...
docs: update multi-tenancy guide
Add information about Enterprise and Retention Filters
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2022-11-01 15:19:09 +01:00
Denys Holius
9ccd22c1f6
Docs: add guide "How to delete and replace metrics" ( #2829 )
...
docs: add guide how to delete and replace metrics
2022-10-25 09:02:14 -04:00
Aliaksandr Valialkin
15849cb571
docs/guides/migrate-from-influx.md: properly display images at https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/docs/guides/migrate-from-influx.md
...
This is a follow-up for 42375679db
2022-10-24 21:28:31 +03:00
Aliaksandr Valialkin
c52c23c272
docs/enterprise.md: describe all the enteprise features in a short doc at https://docs.victoriametrics.com/enterprise.html
2022-10-24 18:02:03 +03:00
Aliaksandr Valialkin
8e998aa1a1
lib/storage: add support for retention filters (aka multiple retentions for distinct sets of time series)
...
Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/143
Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/289
2022-10-24 16:40:20 +03:00
Denys Holius
b1de74a6ba
k8s-monitoring-via-vm-cluster.md: remove extra spaces ( #3234 )
2022-10-13 17:25:35 +02:00
Dan Fredell
42ce4364fc
Multi retention standardization of docs ( #3223 )
...
* Multi retention standardization of docs
While reading through the docs the implementation details had different formatting for storageNode. This standardizes them and adds a link to the retention docs.
* Update docs/guides/guide-vmcluster-multiple-retention-setup.md
Co-authored-by: Aliaksandr Valialkin <valyala@gmail.com>
2022-10-13 10:27:16 +03:00
Artem Navoiev
5d4b1bc742
update multi-region guide, specify multi-level vmselect option ( #3039 )
...
* update multi-region guide, specify multi-level vmselect option
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
* add more references
* Apply suggestions from code review
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-08-30 12:26:23 +03:00
Aliaksandr Valialkin
f2043d53ad
docs: change links to Prometheus docs about instant and range queries to links to VictoriaMetrics docs
2022-08-21 19:01:54 +03:00
Aliaksandr Valialkin
421aca7b2f
docs: fix ordering after adding the docs/relabeling.md
2022-08-18 01:17:27 +03:00
Artem Navoiev
edd7a92e8b
fix typo in influx guide ( #2984 )
2022-08-15 22:59:35 +02:00
Aliaksandr Valialkin
0c95d87abd
docs: fixes after 83a4abda3f
2022-08-05 10:15:00 +03:00
Aliaksandr Valialkin
56622bff73
docs: add Troubleshooting doc
...
This doc contains troubleshooting guides for typical problems with VictoriaMetrics.
2022-06-30 13:53:59 +03:00
Aliaksandr Valialkin
51362f9333
app/vmselect: add -search.setLookbackToStep command-line flag for making the gap filling algorithm similar to InfluxDB data model
...
This option should override `-search.maxStalenessInterval` for most cases when users migrate from InfluxDB to VictoriaMetrics
2022-06-22 14:19:30 +03:00
Artem Navoiev
954a7a6fc6
docs: replace bash code block type with console ( #2746 )
2022-06-19 22:57:53 +03:00
Aliaksandr Valialkin
29b7c0b4a6
docs/guides/migrate-from-influx.md: suggest more real-world value for -search.maxStalenessInterval
...
Suggest `-search.maxStalenessInterval=10s` instead of `-search.maxStalenessInterval=1ms`,
since `1ms` would result in empty graphs in most cases, since the interval between data points
on the graph is usually much higher than 1ms. For example, if the graph shows time range of one hour
and it contains 1000 points, then the interval between points on the graph would equal to
3600s/1000=3.6 seconds.
2022-06-14 12:32:02 +03:00
Roman Khavronenko
aecac75ec7
docs: migrating from influx ( #2720 )
...
Mention `-search.maxStalenessInterval` flag and its effect on query engine.
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2022-06-14 09:10:44 +02:00
Roman Khavronenko
cd2f0e0760
Readme cleanup ( #2715 )
...
* docs: minor styling and wording changes
Changes made after reading https://developers.google.com/tech-writing
Signed-off-by: hagen1778 <roman@victoriametrics.com>
* docs: set proper types for code blocks
Signed-off-by: hagen1778 <roman@victoriametrics.com>
* docs: add `copy` wrapper for some commands
Signed-off-by: hagen1778 <roman@victoriametrics.com>
* docs: sync
Signed-off-by: hagen1778 <roman@victoriametrics.com>
* docs: resolve conflicts
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2022-06-13 09:48:26 +03:00
Yurii Kravets
ac55ca052c
Update README.md ( #2624 )
2022-05-20 15:48:32 +02:00
Roman Khavronenko
b9d7a66800
docs: add migration guide for influxdb ( #2619 )
...
docs: add migration guide for influxdb
Co-authored by @denisgolius
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2022-05-20 11:20:36 +02:00
Aliaksandr Valialkin
242856ce97
docs/guides/multi-regional-setup-dedicated-regions.md: clarify wording on vmagent configuration
2022-05-04 18:49:56 +03:00
Dmytro Kozlov
66a03a7fa9
docs/guides: Multi-regional setup with VictoriaMetrics ( #2416 )
...
* docs/guides: Multi-regional setup with VictoriaMetrics
* docs/guides: cleanup
2022-04-08 11:39:40 +03:00
Dima Lazerka
1fa0f3ec89
VMAnomaly docs fixes ( #2361 )
...
* Added docs for vmanomaly
* Add example images
* Stylistic fixes
* Move images to root
* Update docs/vmanomaly.md
* Update docs/vmanomaly.md
Co-authored-by: Roman Khavronenko <roman@victoriametrics.com>
* Squeeze vmanomaly after vmbackupmanager before Case Studies
Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
Co-authored-by: Roman Khavronenko <roman@victoriametrics.com>
2022-03-25 12:08:17 +02:00
Denys Holius
b3e1119592
Update revisions of dashboards ( #2199 )
...
* update revision of vmcluster for operator guide
* update revision of vmcluster for vmcluster guide
2022-02-15 17:21:42 +02:00
Oct
ca11def2a5
docs: Correct config URL ( #2077 )
...
docs: update incorrect links
2022-01-18 15:06:00 +02:00
Dmitry Tolstoy
b434be3d2d
docs: Correct config URL ( #2051 )
...
Missed /guides folder
2022-01-10 16:24:41 +02:00
Denys Holius
5dc9ab5829
bump revision of dashboards to latest ( #1986 )
2021-12-21 12:11:15 +02:00
Denys Holius
23a03d23aa
added guide-vmcluster-multiple-retention-setup to guides list ( #1891 )
2021-12-02 10:10:25 +02:00
Yurii Kravets
0afec0259b
Create guide-vmcluster-multiple-retention-setup.md ( #1888 )
...
* Create guide-vmcluster-multiple-retention-setup.md
* Apply suggestions from code review
Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2021-12-01 12:42:16 +02:00
Yurii Kravets
5881c4ae48
Add retention-scheme.png
2021-11-30 15:57:44 +02:00
Denys Holius
cd966bf552
bumped grafana dashboards revisions for guides ( #1784 )
2021-11-05 11:43:26 +02:00
Denys Holius
dd4038f0e5
Added some fixes ( #1690 )
...
* removed not needed description
* added some fixes and fixed typos
2021-10-11 11:21:07 +03:00
Denys Holius
4b0cefc4bd
Added fixes and improvements ( #1677 )
...
* added guide for VM operator
* Update docs/guides/getting-started-with-vm-operator.md
Co-authored-by: Roman Khavronenko <hagen1778@gmail.com>
* Update docs/guides/getting-started-with-vm-operator.md
Co-authored-by: Roman Khavronenko <hagen1778@gmail.com>
* Fixed different typos and added improvements from proposals
* move remoteWrite.url to other place
* fixed typo
* rephrased vminsert explanation
* remove not needed parameters for default setup
Co-authored-by: Roman Khavronenko <hagen1778@gmail.com>
2021-10-08 18:57:36 +03:00
Aliaksandr Valialkin
a71c9ad650
docs/guides: follow-up after 05a1396247
2021-10-06 14:46:46 +03:00
Thomas Danielsson
05a1396247
fix: typo metric_relabel_configs ( #1674 )
...
metric_ralabel_configs -> metric_relabel_configs
2021-10-06 14:45:39 +03:00
Denys Holius
81e4d644dd
added guide for HA monitoring setup in K8s via VM Cluster ( #1523 )
...
* added guide for HA monitoring setup in K8s via VM Cluster
* fixed missed divs
* fixed different typos
* Update docs/guides/k8s-ha-monitoring-via-vm-cluster.md
Co-authored-by: Roman Khavronenko <hagen1778@gmail.com>
* Update docs/guides/k8s-ha-monitoring-via-vm-cluster.md
Co-authored-by: Roman Khavronenko <hagen1778@gmail.com>
* Update docs/guides/k8s-ha-monitoring-via-vm-cluster.md
Co-authored-by: Roman Khavronenko <hagen1778@gmail.com>
* Update docs/guides/k8s-ha-monitoring-via-vm-cluster.md
Co-authored-by: Roman Khavronenko <hagen1778@gmail.com>
* Update docs/guides/k8s-ha-monitoring-via-vm-cluster.md
Co-authored-by: Roman Khavronenko <hagen1778@gmail.com>
* Update docs/guides/k8s-ha-monitoring-via-vm-cluster.md
Co-authored-by: Roman Khavronenko <hagen1778@gmail.com>
* Update docs/guides/k8s-ha-monitoring-via-vm-cluster.md
Co-authored-by: Roman Khavronenko <hagen1778@gmail.com>
* Update docs/guides/k8s-ha-monitoring-via-vm-cluster.md
Co-authored-by: Roman Khavronenko <hagen1778@gmail.com>
* Update docs/guides/k8s-ha-monitoring-via-vm-cluster.md
Co-authored-by: Roman Khavronenko <hagen1778@gmail.com>
* Update docs/guides/k8s-ha-monitoring-via-vm-cluster.md
Co-authored-by: Roman Khavronenko <hagen1778@gmail.com>
* Update docs/guides/k8s-ha-monitoring-via-vm-cluster.md
Co-authored-by: Roman Khavronenko <hagen1778@gmail.com>
Co-authored-by: Roman Khavronenko <hagen1778@gmail.com>
2021-08-11 11:45:42 +03:00
Roman Khavronenko
a641102ec2
docs: fix indentation for guide articles ( #1512 )
2021-08-02 17:16:58 +03:00
Denys Holius
9ffd70a921
Added new guide for monitoring k8s via VictoriaMetrics cluster ( #1476 )
...
* renamed and moved screenshots
* fixed cluster guide, updated helm chart versions, added values.yaml for vm single
* renamed guide files
* fixed typo
* add some fixes
* fixed typos,added guide k8s-monitoring-via-vm-cluster
* added fixes for yamls
2021-07-27 18:01:12 +03:00
Roman Khavronenko
75f12bfe78
add option to add Copy button for code snippets ( #1433 )
...
To add a Copy button wrap code snippet with the following element:
```
<div class="with-copy" markdown="1">
<your-code-snippet>
</div>
```
See the changes to `Kubernetes monitoring with VictoriaMetrics Single` for details.
2021-07-06 08:23:39 +03:00
Roman Khavronenko
bd6b8f7e31
move github-pages docs to the main repo ( #1432 )
...
* move github-pages docs to the main repo
* rm github actions for copying docs to VictoriaMetrics/VictoriaMetrics.github.io
2021-07-05 14:34:10 +03:00
