mirror of
https://github.com/VictoriaMetrics/VictoriaMetrics.git
synced 2026-05-17 08:36:55 +03:00
Compare commits
3 Commits
5f5a2109e8
...
f2ba4bb3b6
| Author | SHA1 | Date | |
|---|---|---|---|
|
f2ba4bb3b6 | ||
|
|
170c81d25e | ||
|
|
a50ec995f1 |
@@ -33,6 +33,7 @@ See also [case studies](https://docs.victoriametrics.com/victoriametrics/casestu
|
||||
* [Percona: How do We Keep Metrics for a Long Time in VictoriaMetrics](https://www.youtube.com/watch?v=SGZjY7xgDwE)
|
||||
* [Miro: Prometheus High Availability and Fault Tolerance strategy, long term storage with VictoriaMetrics](https://medium.com/miro-engineering/prometheus-high-availability-and-fault-tolerance-strategy-long-term-storage-with-victoriametrics-82f6f3f0409e)
|
||||
* [ZERODHA: Infrastructure monitoring with Prometheus at Zerodha](https://zerodha.tech/blog/infra-monitoring-at-zerodha/)
|
||||
* [ZERODHA: Monitoring K8s with Victoriametrics](https://www.youtube.com/watch?v=ZJQYW-cFOms)
|
||||
* [Criteo: VictoriaMetrics, a stress-free Prometheus Remote Storage for 1 Billion metrics](https://medium.com/criteo-engineering/victoriametrics-a-prometheus-remote-storage-solution-57081a3d8e61)
|
||||
* [Abios Gaming: Choosing a Time Series Database for High Cardinality Aggregations](https://abiosgaming.com/press/high-cardinality-aggregations/)
|
||||
* [Cybozu: Monitoring Kubernetes clusters with VictoriaMetrics and Grafana](https://blog.cybozu.io/entry/2021/03/18/115743)
|
||||
|
||||
@@ -15,25 +15,28 @@ aliases:
|
||||
- /enterprise/
|
||||
---
|
||||
|
||||
VictoriaMetrics and [VictoriaLogs](https://docs.victoriametrics.com/victorialogs/) components are provided
|
||||
VictoriaMetrics, [VictoriaLogs](https://docs.victoriametrics.com/victorialogs/) and [VictoriaTraces](https://docs.victoriametrics.com/victoriatraces/) components are provided
|
||||
in two kinds - [Community edition](https://victoriametrics.com/products/open-source/) and [Enterprise edition](https://victoriametrics.com/products/enterprise/).
|
||||
|
||||
VictoriaMetrics and VictoriaLogs community components are open source and are free to use:
|
||||
The community components are open source and are free to use:
|
||||
|
||||
- See [VictoriaMetrics source code](https://github.com/VictoriaMetrics/VictoriaMetrics/) and [VictoriaMetrics license](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/LICENSE).
|
||||
- See [VictoriaLogs source code](https://github.com/VictoriaMetrics/VictoriaLogs/) and [VictoriaLogs license](https://github.com/VictoriaMetrics/VictoriaLogs/blob/master/LICENSE).
|
||||
- See [VictoriaTraces source code](https://github.com/VictoriaMetrics/VictoriaTraces/) and [VictoriaLogs license](https://github.com/VictoriaMetrics/VictoriaTraces/blob/master/LICENSE).
|
||||
|
||||
Enterprise components of VictoriaMetrics and VictoriaLogs are available at the following places:
|
||||
Both open-source and enterprise components are available at the following places:
|
||||
|
||||
- Binary executables are available at [the releases page for VictoriaMetrics](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest)
|
||||
and [the release page for VictoriaLogs](https://github.com/VictoriaMetrics/VictoriaLogs/releases/latest).
|
||||
- Binary executables are available at the corresponding releases pages:
|
||||
- [releases page for VictoriaMetrics](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest)
|
||||
- [releases page for VictoriaLogs](https://github.com/VictoriaMetrics/VictoriaLogs/releases/latest)
|
||||
- [releases page for VictoriaTraces](https://github.com/VictoriaMetrics/VictoriaTraces/releases/latest)
|
||||
- Docker images are available at [Docker Hub](https://hub.docker.com/u/victoriametrics) and [Quay](https://quay.io/organization/victoriametrics).
|
||||
|
||||
Enterprise executables and Docker images have `enterprise` suffix in their names and tags.
|
||||
|
||||
## Valid cases for VictoriaMetrics Enterprise
|
||||
|
||||
The use of Enterprise components of VictoriaMetrics and VictoriaLogs is permitted in the following cases:
|
||||
The use of Enterprise components is permitted in the following cases:
|
||||
|
||||
- Evaluation use in non-production setups. Please, request a [trial license](https://victoriametrics.com/products/enterprise/trial/)
|
||||
and then pass it via `-license` or `-licenseFile` command-line flags as described [in these docs](#running-victoriametrics-enterprise).
|
||||
@@ -104,25 +107,26 @@ Contact us via [this page](https://victoriametrics.com/products/enterprise/) if
|
||||
|
||||
## Running VictoriaMetrics Enterprise
|
||||
|
||||
Enterprise components of VictoriaMetrics and VictoriaLogs are available in the following forms:
|
||||
Enterprise components are available in the following forms:
|
||||
|
||||
- [Binary releases](#binary-releases)
|
||||
- [Docker images](#docker-images)
|
||||
- [Helm charts](#helm-charts)
|
||||
- [Kubernetes operator](#kubernetes-operator)
|
||||
- [Binary releases](https://docs.victoriametrics.com/victoriametrics/enterprise/#binary-releases)
|
||||
- [Docker images](https://docs.victoriametrics.com/victoriametrics/enterprise/#docker-images)
|
||||
- [Helm charts](https://docs.victoriametrics.com/victoriametrics/enterprise/#helm-charts)
|
||||
- [Kubernetes operator](https://docs.victoriametrics.com/victoriametrics/enterprise/#kubernetes-operator)
|
||||
|
||||
### Binary releases
|
||||
|
||||
It is allowed to run VictoriaMetrics and VictoriaLogs Enterprise components in [cases listed here](#valid-cases-for-victoriametrics-enterprise).
|
||||
It is allowed to run Enterprise components in [cases listed here](https://docs.victoriametrics.com/victoriametrics/enterprise/#valid-cases-for-victoriametrics-enterprise).
|
||||
|
||||
Binary releases of Enterprise components are available at [the releases page for VictoriaMetrics](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest)
|
||||
and [the releases page for VictoriaLogs](https://github.com/VictoriaMetrics/VictoriaLogs/releases/latest).
|
||||
Binary releases of Enterprise components are available at [the releases page for VictoriaMetrics](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest),
|
||||
[the releases page for VictoriaLogs](https://github.com/VictoriaMetrics/VictoriaLogs/releases/latest)
|
||||
and [the releases page for VictoriaTraces](https://github.com/VictoriaMetrics/VictoriaTraces/releases/latest).
|
||||
Enterprise binaries and packages have `enterprise` suffix in their names. For example, `victoria-metrics-linux-amd64-v1.143.0-enterprise.tar.gz`.
|
||||
|
||||
In order to run binary release of Enterprise component, please download the `*-enterprise.tar.gz` archive for your OS and architecture
|
||||
from the corresponding releases page and unpack it. Then run the unpacked binary.
|
||||
|
||||
All the Enterprise components of VictoriaMetrics and VictoriaLogs require specifying the following command-line flags:
|
||||
All the Enterprise components require specifying the following command-line flags:
|
||||
|
||||
- `-license` - this flag accepts VictoriaMetrics Enterprise license key, which can be obtained at [this page](https://victoriametrics.com/products/enterprise/trial/)
|
||||
- `-licenseFile` - this flag accepts a path to file with VictoriaMetrics Enterprise license key,
|
||||
@@ -148,13 +152,13 @@ Alternatively, VictoriaMetrics Enterprise license can be stored in the file and
|
||||
|
||||
### Docker images
|
||||
|
||||
It is allowed to run VictoriaMetrics and VictoriaLogs Enterprise components in [cases listed here](#valid-cases-for-victoriametrics-enterprise).
|
||||
It is allowed to run Enterprise components in [cases listed here](https://docs.victoriametrics.com/victoriametrics/enterprise/#valid-cases-for-victoriametrics-enterprise).
|
||||
|
||||
Docker images for Enterprise components are available at [VictoriaMetrics Docker Hub](https://hub.docker.com/u/victoriametrics) and [VictoriaMetrics Quay](https://quay.io/organization/victoriametrics).
|
||||
Enterprise docker images have `enterprise` suffix in their names. For example, `victoriametrics/victoria-metrics:v1.143.0-enterprise`.
|
||||
|
||||
In order to run Docker image of VictoriaMetrics Enterprise component, it is required to provide the license key via the command-line
|
||||
flag as described in the [binary-releases](#binary-releases) section.
|
||||
flag as described in the [binary-releases](https://docs.victoriametrics.com/victoriametrics/enterprise/#binary-releases) section.
|
||||
|
||||
Enterprise license key can be obtained at [this page](https://victoriametrics.com/products/enterprise/trial/).
|
||||
|
||||
@@ -194,12 +198,12 @@ The example assumes that the license file is stored at `/vm-license` on the host
|
||||
|
||||
### Helm charts
|
||||
|
||||
It is allowed to run VictoriaMetrics and VictoriaLogs Enterprise components in [cases listed here](#valid-cases-for-victoriametrics-enterprise).
|
||||
It is allowed to run Enterprise components in cases [listed here](https://docs.victoriametrics.com/victoriametrics/enterprise/#valid-cases-for-victoriametrics-enterprise).
|
||||
|
||||
Helm charts for Enterprise components are available in our VictoriaMetrics [Helm repository](https://github.com/VictoriaMetrics/helm-charts).
|
||||
|
||||
In order to run Enterprise helm chart it is required to provide the license key via `license` value in `values.yaml` file
|
||||
and adjust the image tag to the Enterprise one as described in the [docker-images](#docker-images) section.
|
||||
and adjust the image tag to the Enterprise one as described in the [docker-images](https://docs.victoriametrics.com/victoriametrics/enterprise/#docker-images) section.
|
||||
|
||||
Enterprise license key can be obtained at [this page](https://victoriametrics.com/products/enterprise/trial/).
|
||||
|
||||
@@ -250,7 +254,7 @@ Note that the license key provided by using secret is mounted in a file. This al
|
||||
|
||||
### Kubernetes operator
|
||||
|
||||
It is allowed to run VictoriaMetrics and VictoriaLogs Enterprise components in [cases listed here](#valid-cases-for-victoriametrics-enterprise).
|
||||
It is allowed to run Enterprise components in [cases listed here](https://docs.victoriametrics.com/victoriametrics/enterprise/#valid-cases-for-victoriametrics-enterprise).
|
||||
|
||||
Enterprise components can be deployed via [VictoriaMetrics operator](https://docs.victoriametrics.com/operator/).
|
||||
In order to use Enterprise components it is required to provide the license key via `license` field and adjust the image tag to the enterprise one.
|
||||
@@ -313,7 +317,7 @@ See the full list of the CRD specifications in the [Operator API](https://docs.v
|
||||
|
||||
### Updating the license key
|
||||
|
||||
Updating the license key for VictoriaMetrics and VictoriaLogs Enterprise components depends on the way
|
||||
Updating the license key for Enterprise components depends on the way
|
||||
the license key is provided to the component:
|
||||
- If the license key is provided via `-license` command-line flag, then the component should be restarted
|
||||
with the new license key.
|
||||
@@ -351,7 +355,7 @@ Example Docker image:
|
||||
|
||||
## Monitoring license expiration
|
||||
|
||||
All the VictoriaMetrics and VictoriaLogs Enterprise components expose the following metrics at the `/metrics` page:
|
||||
All the Enterprise components expose the following metrics at the `/metrics` page:
|
||||
|
||||
- `vm_license_expires_at` - license expiration date in unix timestamp format
|
||||
- `vm_license_expires_in_seconds` - the number of seconds left until the license expires
|
||||
|
||||
@@ -12,21 +12,21 @@ aliases:
|
||||
---
|
||||
## Goals
|
||||
|
||||
1. The main goal - **to help users and [clients](https://docs.victoriametrics.com/victoriametrics/enterprise/) using VictoriaMetrics and VictoriaLogs component in the most efficient way**.
|
||||
1. The main goal - **to help users and [clients](https://docs.victoriametrics.com/victoriametrics/enterprise/) using VictoriaMetrics products in the most efficient way**.
|
||||
1. Fixing bugs in the essential functionality of VictoriaMetrics components. Small usability bugs are usually the most annoying,
|
||||
so they **must be fixed first**. Bugs, which affect a small number of users at some rare edge cases, can be fixed later.
|
||||
1. Improving [docs](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs) for VictoriaMetrics components,
|
||||
so users could find answers to their questions via Google or [Perplexity](https://www.perplexity.ai/) without the need
|
||||
1. Improving [public docs for VictoriaMetrics products](https://docs.victoriametrics.com).
|
||||
so users could find answers to their questions via Google or any other AI-powered web search without the need
|
||||
to ask these questions at our [support channels](https://docs.victoriametrics.com/victoriametrics/single-server-victoriametrics/#community-and-contributions).
|
||||
1. Simplifying usage of VictoriaMetrics components without breaking backwards compatibility, so users could regularly
|
||||
upgrade to [the latest available release](https://docs.victoriametrics.com/victoriametrics/changelog/) and remain happy.
|
||||
1. Improving usability for the existing functionality of VictoriaMetrics components.
|
||||
1. Simplifying usage of VictoriaMetrics products without breaking backwards compatibility, so users could regularly
|
||||
upgrade to [the latest available release](https://docs.victoriametrics.com/victoriametrics/changelog/) and become happier.
|
||||
1. Improving the usability for the existing functionality of VictoriaMetrics components.
|
||||
1. Improving the readability and maintainability of the code base by removing unnecessary abstractions and simplifying the code whenever possible.
|
||||
1. Improving development velocity by optimizing and simplifying CI/CD tasks, so they take less time to execute and debug.
|
||||
|
||||
## Non-goals
|
||||
|
||||
1. Convincing people to use VictoriaMetrics components when there are better suited solutions exist for their tasks,
|
||||
1. Convincing people to use VictoriaMetrics products when there are better suited solutions exist for their tasks,
|
||||
since users will become angry at VictoriaMetrics after they discover better solutions.
|
||||
1. Breaking links to [VictoriaMetrics docs](https://docs.victoriametrics.com/victoriametrics/), since users will be unhappy seeing 404 page
|
||||
or unexpected results after they click some old link somewhere on the Internet or in the internal knowledge base.
|
||||
@@ -35,25 +35,29 @@ aliases:
|
||||
since these features may break the essential functionality of VictoriaMetrics components, so a big share
|
||||
of the existing users may become unhappy after the upgrade.
|
||||
1. Adding unnecessary abstractions, since they may worsen project maintainability in the future.
|
||||
1. Implementing all the features users ask. These features should fit [the goals](#goals) of VictoriaMetrics.
|
||||
1. Implementing all the features users ask. These features should fit [the goals](https://docs.victoriametrics.com/victoriametrics/goals/#goals) of VictoriaMetrics.
|
||||
Other feature requests must be closed as `won't implement`, with the link to this page.
|
||||
1. Merging all the pull requests users submit. These pull requests should fit [the goals](#goals) of VictoriaMetrics.
|
||||
1. Merging all the pull requests users submit. These pull requests should fit [the goals](https://docs.victoriametrics.com/victoriametrics/goals/#goals) of VictoriaMetrics.
|
||||
Other pull requests must be closed as `won't merge`, with the link to this page.
|
||||
1. Slowing down and complicating CI/CD pipelines with non-essential tasks, since this results in development velocity slowdown.
|
||||
1. Introducing non-essential requirements, since this slows down development velocity.
|
||||
|
||||
## VictoriaMetrics proverbs
|
||||
|
||||
- **Small usability fix is better than non-trivial feature.** Usability fix makes happy existing users.
|
||||
Non-trivial feature may make happy some new users, while it may make upset a big share of existing users
|
||||
if the feature breaks some essential functionality of VictoriaMetrics components or makes it less efficient.
|
||||
- **A small usability improvement is more valuable than a major new feature.**
|
||||
The usability fix makes happy existing users. Non-trivial feature may make happy some new users,
|
||||
while it may make upset a big share of existing users if the feature breaks the essential functionality
|
||||
of VictoriaMetrics products or makes it less efficient.
|
||||
|
||||
- **Good docs are better than new shiny feature.** Good docs help users discovering new functionality and dealing
|
||||
with VictoriaMetrics components in the most efficient way. Nobody uses new shiny feature if it isn't documented properly.
|
||||
- **Having clean and concise documentation is more valuable than having a lot of great but undocumented features.**
|
||||
Good docs help users discovering new functionality and dealing with VictoriaMetrics products in the most efficient way.
|
||||
Nobody uses new shiny features if they aren't documented properly.
|
||||
|
||||
- **Happy users are more important than the momentary revenue.** Happy users spread the word about VictoriaMetrics,
|
||||
so more people convert to VictoriaMetrics users. Happy users are eager to become happy [customers](https://docs.victoriametrics.com/victoriametrics/enterprise/).
|
||||
This increases long-term revenue.
|
||||
- **A simple solution is better than a smart one.**
|
||||
The simple solution is easier to setup, operate, debug and troubleshoot than the smart solution. This saves users' time, costs and nerve cells.
|
||||
|
||||
- **Simple solution is better than smart solution.** Simple solution is easier to setup, operate, debug and troubleshoot than the smart solution.
|
||||
This saves users' time, costs and nerve cells.
|
||||
- **Happy users are more important than the short-term profit.**
|
||||
Happy users spread the word about VictoriaMetrics, so more people convert to VictoriaMetrics users.
|
||||
Happy users are eager to become happy [customers](https://docs.victoriametrics.com/victoriametrics/enterprise/)
|
||||
over time. This increases long-term profit.
|
||||
Upset users may be forced to become customers, but they will constantily search for the opportunity to switch to competing solutions.
|
||||
|
||||
Reference in New Issue
Block a user