Yurii Kravets
20cef877a1
Update docs ( #2566 )
...
* deployment/docker: pass `-buildvs=false` to `go build` for production builds
This should resolve the `error obtaining VCS status: exit status 128` error
when the environment contains incorrect version of git or has incorrect access rights
to the directory with VictoriaMetrics source code.
See the following links for additional info:
- https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2508#issuecomment-1117126702 ,
- https://github.com/google/ko/issues/672
- https://github.com/golang/go/issues/49004
* lib/netutil: limit the number of concurrently established connections when calling ConnPool.Get()
This should reduce potential spikes in the number of established connections in the following cases:
- when the connection establishing procedure becomes temporarily slow
- after a temporary spike in the rate of ConnPool.Get() calls
See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2552
* docs/CHANGELOG.md: document c8af625bcc
See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1322#issuecomment-1120276146
* docs/Cluster-VictoriaMetrics.md: typo fix: `by by` -> `by`
* docs: add `resource usage limits` docs, which describe fine-grained tuning for various resource usage limits
* docs/Cluster-VictoriaMetrics.md: the `/api/v1/label/.../values` query can take CPU and ram at both vmstorage and vmselect
* Update root Readme and root vmagent readme
Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-05-12 19:22:13 +02:00
Aliaksandr Valialkin
7ddf9f0700
docs/Cluster-VictoriaMetrics.md: the /api/v1/label/.../values
query can take CPU and ram at both vmstorage and vmselect
2022-05-11 20:01:24 +03:00
Aliaksandr Valialkin
73cbc87dbb
docs: add resource usage limits
docs, which describe fine-grained tuning for various resource usage limits
2022-05-11 19:52:03 +03:00
Aliaksandr Valialkin
b828c6e1ff
docs/Cluster-VictoriaMetrics.md: typo fix: by by
-> by
2022-05-11 18:13:07 +03:00
Aliaksandr Valialkin
80092f087e
docs/Cluster-VictoriaMetrics.md: typo fix: bandidth -> bandwidth
2022-05-06 16:35:36 +03:00
Aliaksandr Valialkin
8100c9a301
docs/Cluster-VictoriaMetrics.md: make the description for -rpc.disableCompression
command-line flag more clear
2022-05-06 16:27:33 +03:00
Aliaksandr Valialkin
6343b20943
docs/Cluster-VictoriaMetrics.md: update cluster scalability tips
2022-05-05 21:11:51 +03:00
Aliaksandr Valialkin
4e4ca1b6db
docs/Cluster-VictoriaMetrics.md: move environment variables
entry closer to cluster setup
section
2022-05-04 18:43:57 +03:00
Aliaksandr Valialkin
2e6827ff04
docs/CHANGELOG.md: document 8639e79d38
2022-05-04 10:46:03 +03:00
Aliaksandr Valialkin
1c7a541247
docs/Cluster-VictoriaMetrics.md: typo fix: serparated -> separated
2022-05-03 15:19:15 +03:00
Aliaksandr Valialkin
b5fedfd3bb
all: add -cluster.tlsInsecureSkipVerify command-line option to vminsert, vmselect and vmstorage components in order to be able to disable TLS certificate verification in mTLS mode
...
See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2490
2022-05-03 13:12:50 +03:00
Aliaksandr Valialkin
528b332fe0
docs/Cluster-VictoriaMetrics.md: refer to the doc on how to set up mTLS
2022-05-03 11:55:06 +03: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
ce1190974c
docs/Cluster-VictoriaMetrics.md: remove incorrect and misleading instructions for passing -replicationFactor
flag to vmselect nodes in multi-level setup.
...
The `-replicationFactor` passed to top-level `vmselect` nodes mustn't exceed the `-replicationFactor` passed to top-level `vminsert` nodes
2022-04-26 15:13:56 +03:00
Aliaksandr Valialkin
1970b3db34
docs/Cluster-VictoriaMetrics.md: mention that enterprise binaries are available for evaluation
2022-04-21 15:58:03 +03:00
Aliaksandr Valialkin
f62fc2f318
docs/Cluster-VictoriaMetrics.md: sync docs
2022-04-16 16:59:27 +03:00
Aliaksandr Valialkin
cad488fe7e
app/vmstorage: add support for mTLS cipher suites via -cluster.tlsCipherSuites
command-line flag
...
Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/2404
2022-04-16 16:39:21 +03:00
Aliaksandr Valialkin
54bb8c2bc6
docs/Cluster-VictoriaMetrics.md: update docs after 26ae50ec26
2022-04-16 16:04:58 +03:00
Aliaksandr Valialkin
057c3a745f
docs/Cluster-VictoriaMetrics.md: clarify the issue with multi-level cluster, which may result in data gaps at some AZs
2022-04-16 13:04:29 +03:00
Aliaksandr Valialkin
4169b97af9
docs/Cluster-VictoriaMetrics.md: improve docs on cluster setup, resizing and scalability
2022-04-15 15:05:47 +03:00
Aliaksandr Valialkin
b11e9de386
docs/Cluster-VictoriaMetrics.md: mention about possible issues with multi-level cluster setup
2022-04-15 15:05:45 +03:00
Aliaksandr Valialkin
f1ad5b6857
docs/Cluster-VictoriaMetrics.md: update docs after b843f0e229
2022-04-10 16:18:21 +03:00
Aliaksandr Valialkin
a0e77744d4
docs/Cluster-VictoriaMetrics.md: clarify high availability docs
2022-04-08 12:51:57 +03:00
Aliaksandr Valialkin
b421a1f57b
docs/Cluster-VictoriaMetrics.md: clarify mTLS protection docs
2022-03-22 13:55:40 +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
11869a8307
docs: document the addition of mTLS communication between cluster components
2022-03-17 20:00:56 +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
Roman Khavronenko
3ac3124eed
docs: make profiling commands more copy-friendly ( #2213 )
...
* docs: make profiling commands more copy-friendly
The change adds `copy text` snippet to code examples
and replaces hostname placeholders with `0.0.0.0`.
Signed-off-by: hagen1778 <roman@victoriametrics.com>
* Apply suggestions from code review
* Apply suggestions from code review
* Apply suggestions from code review
Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
2022-02-18 12:23:36 +02:00
Aliaksandr Valialkin
ee5da826e9
docs: update -help
output for VictoriaMetrics components
2022-02-15 21:08:22 +02:00
Aliaksandr Valialkin
3e783aa2a1
docs/Cluster-VictoriaMetrics.md: sync with cluster branch
2022-02-08 15:43:21 +02:00
Aliaksandr Valialkin
baab622db6
docs: fix links to FAQ.md entries after they have been changed in ccf04239e6
2022-02-07 16:02:44 +02:00
Aliaksandr Valialkin
865f09ecbb
docs: sync with cluster branch
2022-02-07 14:54:16 +02:00
Aliaksandr Valialkin
eb4bd92fac
all: update link to EULA from https://victoriametrics.com/assets/VM_EULA.pdf to https://victoriametrics.com/legal/eula/
2022-01-20 22:23:27 +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
Yurii Kravets
f0c331c724
Update README.md ( #1996 )
...
* Update README.md
go 1.16 -> 1.17
* Update README.md
* Update README.md
* Update Cluster-VictoriaMetrics.md
* Update Single-server-VictoriaMetrics.md
* Update vmauth.md
* Update vmbackup.md
* Update vmrestore.md
* Update vmagent.md
* Update vmctl.md
* Update README.md
* Update README.md
* Update README.md
* Update README.md
* Update README.md
2021-12-23 12:09:59 +02:00
Aliaksandr Valialkin
27a1ae57e5
docs: mention -storage.minFreeDiskSpaceBytes
command-line flag at capacity planning
section
...
See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1727 and https://github.com/VictoriaMetrics/VictoriaMetrics/issues/269
2021-12-15 21:41:30 +02:00
Aliaksandr Valialkin
65bef771f6
docs/Cluster-VictoriaMetrics.md: mention about the added downsampling support
2021-12-15 16:40:15 +02:00
Aliaksandr Valialkin
2711d2ea55
docs/Single-server-VictoriaMetrics.md: move features chapter above the case studies
chapter
2021-12-08 12:49:09 +02:00
Aliaksandr Valialkin
4888e2c232
docs/Cluster-VictoriaMetrics.md: sync with cluster branch
2021-12-03 00:13:02 +02:00
vic
1fb3dbcbda
Update Cluster-VictoriaMetrics.md ( #1806 )
...
replicationFactor flag should be passed to vmselect instead of vminsert for improving query speed:)
2021-11-17 00:59:43 +02:00
Aliaksandr Valialkin
a67518fc6d
docs: mention that graphs on the official dashboards contain useful hints
2021-11-08 19:54:10 +02:00
Aliaksandr Valialkin
d5825f13d3
docs/Cluster-VictoriaMetrics.md: add links with the explanation of active time series and series churn rate
2021-10-24 18:40:19 +03:00
Aliaksandr Valialkin
cf5cbd1c70
app/{vminsert,vmstorage}: follow-up after a171916ef5
...
Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/269
2021-10-08 14:35:49 +03:00
Aliaksandr Valialkin
6d9f1d4227
app/vminsert: document that -relabelConfig is reloaded on SIGHUP signal
2021-09-29 21:18:58 +03:00
Aliaksandr Valialkin
91b3c601bc
app/{vminsert,vmagent}: add ability to ingest data via DataDog "submit metrics" API
...
See https://docs.datadoghq.com/api/latest/metrics/#submit-metrics
Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/206
2021-09-29 00:13:08 +03:00
n4mine
1ac8d55147
fix: typo, dddresses -> addresses ( #1630 )
2021-09-20 14:28:59 +03:00
Aliaksandr Valialkin
44b01fff13
app/{vminsert,vmselect}: automatically add missing port in -storageNode
lists passed to vminsert
and vmselect
...
This should simplify manual setup of the cluster according to https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#cluster-setup
2021-09-15 18:08:30 +03:00
Aliaksandr Valialkin
8a6a36429a
app/vminsert/netstorage: disable rerouting by default
...
Production clusters work more stable with the disabled rerouting during rolling restarts and/or
during spikes in time series churn rate. So it would be better disabling the rerouting by default.
The re-routing can be enabled by passing `-disableRerouting=false` command-line flag to `vminsert` nodes.
Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/791
Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1054
Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1165
2021-09-13 18:51:56 +03:00
Aliaksandr Valialkin
7f0a8d4bdb
docs: consistency renaming: Influx -> InfluxDB
2021-09-13 17:05:16 +03:00
Aliaksandr Valialkin
9fc9d76a7f
docs/Cluster-VictoriaMetrics.md: mention that the -replicationFactor
at vmselect
is an optional parameter
2021-08-25 13:10:57 +03:00
Aliaksandr Valialkin
cdc372bb98
app/vmselect: add -search.noStaleMarkers
command-line flag for disabling stale markers handling in queries
...
This option allows reducing CPU usage a bit when VictoriaMetrics is used
for collecting and processing non-Prometheus data. For example, InfluxDB line protocol, Graphite, OpenTSDB, CSV, etc.
2021-08-18 13:59:02 +03:00
Aliaksandr Valialkin
9a8d1bcec5
docs/Cluster-VictoriaMetrics.md: meniton that vmagent can be used for replicating the data among multiple clusters
...
Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1491
2021-08-12 12:47:32 +03:00
Aliaksandr Valialkin
869ff25392
docs/Cluster-VictoriaMetrics.md: update -help
output for cluster components after the d375d9b878
2021-08-11 11:44:39 +03:00
Aliaksandr Valialkin
8ee8660ac4
app/vmselect: follow-up for 626073bca8
...
* Rename -search.maxMetricsPointSearch to -search.maxSamplesPerQuery, so it is more consistent with the existing -search.maxSamplesPerSeries
* Move the -search.maxSamplesPerQuery from vmstorage to vmselect, so it could effectively limit the number of raw samples obtained from all the vmstorage nodes
* Document the -search.maxSamplesPerQuery in docs/CHANGELOG.md
2021-07-28 18:00:23 +03:00
Aliaksandr Valialkin
8d99e94a52
docs: clarify why spare CPU and RAM resources are needed in capacity planning
2021-07-13 15:48:25 +03:00
Aliaksandr Valialkin
8d0ec47be9
docs/Cluster-VictoriaMetrics.md: clarify the docs about the needed values for -dedup.minScrapeInterval
at vmselect
during replication when the data is pushed from HA pair
2021-07-13 15:43:02 +03:00
Aliaksandr Valialkin
a684408e27
docs: update http://slack.victoriametrics.com to https://slack.victoriametrics.com
2021-07-12 10:57:16 +03:00
Aliaksandr Valialkin
f539772ca6
docs: sync with the cluster branch
2021-07-10 12:45:38 +03:00
Aliaksandr Valialkin
8c764e88f0
app/vmui: move source code from https://github.com/VictoriaMetrics/vmui to app/vmui
...
Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1413
2021-07-09 17:15:23 +03:00
Aliaksandr Valialkin
2be340a4c9
docs: clarify what does "workload" mean in capacity planning docs
2021-07-09 12:49:53 +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
92b8380fdf
docs/Cluster-VictoriaMetrics.md: improve capacity planning recommendations
2021-07-07 16:22:51 +03:00
Aliaksandr Valialkin
c55a64ba08
docs: clarify capacity planning
docs
2021-07-07 12:46:55 +03:00
Aliaksandr Valialkin
f6bb130898
app/{vmselect,vmstorage}: clarify the description for -dedup.minScrapeInterval
command-line flag
...
Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1426
2021-07-02 15:05:57 +03:00
Aliaksandr Valialkin
1e52f11e87
docs/Cluster-VictoriaMetrics.md: typo fix: siplify -> simplify
2021-07-02 10:50:55 +03:00
Aliaksandr Valialkin
5beb099ff9
docs/Cluster-VictoriaMetrics.md: add a chapter describing a toy cluster setup on a single host
...
While at it, refer to available tools, which can simplify cluster setup
2021-07-02 10:48:56 +03:00
Aliaksandr Valialkin
eb1af09a04
docs/Cluster-VictoriaMetrics.md: clarify docs about VictoriaMetrics cluster architecture
2021-06-18 14:36:39 +03:00
Aliaksandr Valialkin
3e5b6bae66
docs/Cluster-VictoriaMetrics.md: add lists for command-line flags for cluster components
2021-06-14 12:22:05 +03:00
Aliaksandr Valialkin
b22e380a34
app/vmauth: allow balancing the load among multiple backend nodes by specifying multiple urls in url_prefix
config
2021-05-29 01:03:37 +03:00
Roman Khavronenko
2bbb1cc7c1
Docs review ( #1330 )
...
* re-order components by prioritizing Cluster-VictoriaMetrics.md
* drop Home.md since it just duplicates other links
2021-05-26 12:28:58 +03:00
Aliaksandr Valialkin
d06aae9454
docs/FAQ.md: add a question about multi-tenancy
...
The question has been extracted from https://github.com/VictoriaMetrics/VictoriaMetrics/pull/1284
2021-05-20 15:52:40 +03:00
Aliaksandr Valialkin
832651c6c2
app/vmselect: follow up after 8a0678678b
...
Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1168
2021-05-12 17:18:30 +03:00
Aliaksandr Valialkin
12d733dd5d
app/vminsert: add support for data ingestion via other vminsert nodes
2021-05-08 19:52:57 +03:00
Aliaksandr Valialkin
86bdb5ea95
docs/Cluster-VictoriaMetrics.md: document api/v1/series/count
endpoint
2021-04-30 11:46:14 +03:00
Aliaksandr Valialkin
478c56f281
docs/Cluster-VictoriaMetrics.md: sync with cluster branch
2021-04-22 14:49:16 +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
cc94afeacc
docs/Cluster-VictoriaMetrics.md: sync with cluster README.md
2021-04-19 13:31:55 +03:00
Aliaksandr Valialkin
574b80f274
docs/Cluster-VictoriaMetrics.md: mention that sometimes -replicationFactor
shouldnt be set at vmselect
nodes
...
Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1207
2021-04-14 13:07:59 +03:00
Aliaksandr Valialkin
06e962f141
docs/Cluster-VictoriaMetrics.md: recommend setting up official alerts for VictoriaMetrics components
2021-04-08 12:15:24 +03:00
Aliaksandr Valialkin
75f309fbbf
docs/Cluster-VictoriaMetrics.md: follow-up after c6a8ebb11f
2021-04-07 13:47:46 +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 c0ac740f93
, which uses URL.Redacted() method,
which has been added in v1.15.
Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1147
2021-03-29 23:04:53 +03:00
Aliaksandr Valialkin
50f790b5d7
docs/Cluster-VictoriaMetrics.md: mention that vmselect doesnt serve partial responses from export API
...
Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1148
2021-03-25 21:04:13 +02:00
Aliaksandr Valialkin
88f6286df7
docs/Cluster-VictoriaMetrics.md: sync with upstream
2021-03-25 17:18:18 +02:00
Aliaksandr Valialkin
6d91842c83
docs/Cluster-VictoriaMetrics.md: sync with cluster README.md
2021-03-15 11:51:40 +02:00
Aliaksandr Valialkin
201b685b13
all: bump minimum supported Go version from 1.13 to 1.14
2021-03-03 15:57:13 +02:00
Aliaksandr Valialkin
01d82cbf21
docs/Cluster-VictoriaMetrics.md: clarify replication docs
2021-02-15 01:45:09 +02:00
Aliaksandr Valialkin
baa36354e0
docs/Cluster-VictoriaMetrics.md: mention that /api/v1/import/prometheus
supports OpenMetrics data
2021-02-12 00:59:54 +02:00
Aliaksandr Valialkin
4abd71402e
docs/Cluster-VictoriaMetrics.md: sync with cluster branch
2021-02-03 12:14:58 +02:00
Aliaksandr Valialkin
2a7b1cc668
docs/Cluster-VictoriaMetrics.md: mention about -search.denyPartialResponse
command-line flag and deny_partial_response
query arg
2021-01-27 14:07:00 +02:00
Aliaksandr Valialkin
4b7105a65b
app/vmselect: sync query stats handling with cluster version
2020-12-27 13:00:29 +02:00
Aliaksandr Valialkin
0e082b1c76
docs/Cluster-VictoriaMetrics.md: fix incorrect commands for profile collecting
2020-12-16 01:07:16 +02:00
Aliaksandr Valialkin
1b9992b42a
docs/Cluster-VictoriaMetrics.md: add Profiling
section
2020-12-16 01:00:44 +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
fb8e56d8a2
docs/Cluster-VictoriaMetrics.md: sync with cluster branch
2020-11-23 15:32:56 +02:00
Aliaksandr Valialkin
e614a14b21
docs: sync with cluster branch
2020-11-23 00:42:04 +02:00
Aliaksandr Valialkin
7e4bcbd853
docs/Cluster-VictoriaMetrics.md: adjust RAM sizing recommendations for vmstorage nodes
...
It is recommended to have at least of 50% of free RAM on vmstorage nodes in order handle possible
RAM usage spikes during rolling upgrade for vmstorage nodes when time series
are re-routed from temporarily unavailable node to the remaining active nodes.
2020-11-18 13:04:43 +02:00
Aliaksandr Valialkin
1052effb6d
docs/Cluster-VictoriaMetrics.md: make docs-sync
after 57dc152e9d
2020-11-16 20:20:31 +02:00
Aliaksandr Valialkin
72ab3f7230
docs/Cluster-VictoriaMetrics.md: sync with cluster
branch
2020-11-16 15:35:37 +02:00