update wiki pages

Vika 2023-01-27 22:08:28 +00:00
parent 95cec79e96
commit 08d7c7e63f
31 changed files with 42 additions and 27 deletions

@ -20,6 +20,7 @@ The following tip changes can be tested by building VictoriaMetrics components f
* FEATURE: [vmui](https://docs.victoriametrics.com/#vmui): improve visual appearance of the top menu. See [this feature request](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3678). * FEATURE: [vmui](https://docs.victoriametrics.com/#vmui): improve visual appearance of the top menu. See [this feature request](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3678).
* FEATURE: [vmui](https://docs.victoriametrics.com/#vmui): embed fonts into binary instead of loading them from external sources. This allows using `vmui` in full from isolated networks without access to Internet. Thanks to @ScottKevill for [the pull request](https://github.com/VictoriaMetrics/VictoriaMetrics/pull/3696). * FEATURE: [vmui](https://docs.victoriametrics.com/#vmui): embed fonts into binary instead of loading them from external sources. This allows using `vmui` in full from isolated networks without access to Internet. Thanks to @ScottKevill for [the pull request](https://github.com/VictoriaMetrics/VictoriaMetrics/pull/3696).
* FEATURE: [vmagent](https://docs.victoriametrics.com/vmagent.html): reduce memory usage when sending stale markers for targets, which expose big number of metrics. See [this](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3668) and [this](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3675) issues. * FEATURE: [vmagent](https://docs.victoriametrics.com/vmagent.html): reduce memory usage when sending stale markers for targets, which expose big number of metrics. See [this](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3668) and [this](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3675) issues.
* FEATURE: [vmauth](https://docs.victoriametrics.com/vmauth.html): allow limiting the number of concurrent requests sent to `vmauth` via `-maxConcurrentRequests` command-line flag. This allows controlling memory usage of `vmauth` and the resource usage of backends behind `vmauth`. See [this feature request](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3346). Thanks to @dmitryk-dk for [the initial implementation](https://github.com/VictoriaMetrics/VictoriaMetrics/pull/3486).
* FEATURE: allow using VictoriaMetrics components behind proxies, which communicate with the backend via [proxy protocol](https://www.haproxy.org/download/2.3/doc/proxy-protocol.txt). See [this feature request](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3335). For example, [vmauth](https://docs.victoriametrics.com/vmauth.html) accepts proxy protocol connections when it starts with `-httpListenAddr.useProxyProtocol` command-line flag. * FEATURE: allow using VictoriaMetrics components behind proxies, which communicate with the backend via [proxy protocol](https://www.haproxy.org/download/2.3/doc/proxy-protocol.txt). See [this feature request](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3335). For example, [vmauth](https://docs.victoriametrics.com/vmauth.html) accepts proxy protocol connections when it starts with `-httpListenAddr.useProxyProtocol` command-line flag.
* FEATURE: add `-internStringMaxLen` command-line flag, which can be used for fine-tuning RAM vs CPU usage in certain workloads. For example, if the stored time series contain long labels, then it may be useful reducing the `-internStringMaxLen` in order to reduce memory usage at the cost of increased CPU usage. See [this issue](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3692). * FEATURE: add `-internStringMaxLen` command-line flag, which can be used for fine-tuning RAM vs CPU usage in certain workloads. For example, if the stored time series contain long labels, then it may be useful reducing the `-internStringMaxLen` in order to reduce memory usage at the cost of increased CPU usage. See [this issue](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3692).
@ -27,6 +28,8 @@ The following tip changes can be tested by building VictoriaMetrics components f
* BUGFIX: [VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html): propagate all the timeout-related errors from `vmstorage` to `vmselect` when `vmstorage`. Previously some timeout errors weren't returned from `vmselect` to `vmstorage`. Instead, `vmstorage` could log the error and close the connection to `vmselect`, so `vmselect` was logging cryptic errors such as `cannot execute funcName="..." on vmstorage "...": EOF`. * BUGFIX: [VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html): propagate all the timeout-related errors from `vmstorage` to `vmselect` when `vmstorage`. Previously some timeout errors weren't returned from `vmselect` to `vmstorage`. Instead, `vmstorage` could log the error and close the connection to `vmselect`, so `vmselect` was logging cryptic errors such as `cannot execute funcName="..." on vmstorage "...": EOF`.
* BUGFIX: [vmui](https://docs.victoriametrics.com/#vmui): add support for time zone selection for older versions of browsers. See [this pull request](https://github.com/VictoriaMetrics/VictoriaMetrics/pull/3680). * BUGFIX: [vmui](https://docs.victoriametrics.com/#vmui): add support for time zone selection for older versions of browsers. See [this pull request](https://github.com/VictoriaMetrics/VictoriaMetrics/pull/3680).
* BUGFIX: [vmagent](https://docs.victoriametrics.com/vmagent.html): update API version for [ec2_sd_configs](https://docs.victoriametrics.com/sd_configs.html#ec2_sd_configs) to fix [the issue](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3700) with missing `__meta_ec2_availability_zone_id` attribute. * BUGFIX: [vmagent](https://docs.victoriametrics.com/vmagent.html): update API version for [ec2_sd_configs](https://docs.victoriametrics.com/sd_configs.html#ec2_sd_configs) to fix [the issue](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3700) with missing `__meta_ec2_availability_zone_id` attribute.
* BUGFIX: [vmauth](https://docs.victoriametrics.com/vmauth.html): allow re-entering authorization info in the web browser if the entered info was incorrect. Previously it was non-trivial to do via the web browser, since `vmauth` was returning `400 Bad Request` instead of `401 Unauthorized` http response code.
* BUGFIX: [vmauth](https://docs.victoriametrics.com/vmauth.html): always log the client address and the requested URL on proxying errors. Previously some errors could miss this information.
## [v1.86.2](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/tag/v1.86.2) ## [v1.86.2](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/tag/v1.86.2)

12
assets/README.md Normal file

@ -0,0 +1,12 @@
This folder must contain only files, which are needed for generating https://docs.victoriametrics.com .
This folder **should not contain** files specific for a particular documentation pages such as images
used in a particular doc. Such files must be placed in the same folder as the doc itself
and they must have the same prefix as the doc filename. For example, all the images for docs/foo/bar.md
should have filenames starting from docs/foo/bar. This simplifies lifetime management for these files.
For example, if the corresponding doc is removed, then it is easy to remove all the associated
images with a simple `rm -rf docs/foo/bar*` command. This also simplifies referring the associated images
from docs displayed at various views:
- https://docs.victoriametrics.com
- https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs

@ -18,19 +18,19 @@ To start using the service, one should have already registered AWS account. Then
and click "Continue to Subscribe" button: and click "Continue to Subscribe" button:
<p> <p>
<img src="/assets/images/managed/quickstart/continue-subscribe.png" width="800"> <img src="quickstart_continue-subscribe.png" width="800">
</p> </p>
Then on product page press the "Subscribe" button: Then on product page press the "Subscribe" button:
<p> <p>
<img src="/assets/images/managed/quickstart/subscribe.png" width="800"> <img src="quickstart_subscribe.png" width="800">
</p> </p>
You'll be taken to <a href="https://dbaas.victoriametrics.com/signIn">Managed VictoriaMetrics auth page</a>: You'll be taken to <a href="https://dbaas.victoriametrics.com/signIn">Managed VictoriaMetrics auth page</a>:
<p> <p>
<img src="/assets/images/managed/quickstart/quickstart-signIn.png" width="800"> <img src="quickstart_signin.png" width="800">
</p> </p>
Choose to register manually or via Google Auth. Choose to register manually or via Google Auth.
@ -46,13 +46,13 @@ If you forgot password, it can be restored in the following way:
1. Click `Forgot your password?` link at [this page](https://dbaas.victoriametrics.com/signIn): 1. Click `Forgot your password?` link at [this page](https://dbaas.victoriametrics.com/signIn):
<p> <p>
<img src="/assets/images/managed/quickstart/restore-password.png" width="800"> <img src="quickstart_restore-password.png" width="800">
</p> </p>
2. Enter your email in the field and click `Send Email` button: 2. Enter your email in the field and click `Send Email` button:
<p> <p>
<img src="/assets/images/managed/quickstart/restore-password-email.png" width="800"> <img src="quickstart_restore-password-email.png" width="800">
</p> </p>
3. Follow the instruction sent to your email in order to gain access to your VictoriaMetrics cloud account: 3. Follow the instruction sent to your email in order to gain access to your VictoriaMetrics cloud account:
@ -70,13 +70,13 @@ In case of questions contact our support support@victoriametrics.com
4. Navigate to the Profile page by clicking the corresponding link at the top right corner: 4. Navigate to the Profile page by clicking the corresponding link at the top right corner:
<p> <p>
<img src="/assets/images/managed/quickstart/restore-password-profile.png" width="800"> <img src="quickstart_restore-password-profile.png" width="800">
</p> </p>
5. Enter new password at the Profile page and press `Save` button: 5. Enter new password at the Profile page and press `Save` button:
<p> <p>
<img src="/assets/images/managed/quickstart/restore-password-save-password.png" width="800"> <img src="quickstart_restore-password-save-password.png" width="800">
</p> </p>
@ -86,7 +86,7 @@ Instances is a page where user can list and manage VictoriaMetrics single-node i
To create an instance click on the button `Create`: To create an instance click on the button `Create`:
<p> <p>
<img src="/assets/images/managed/quickstart/quickstart-instances.png" width="800"> <img src="quickstart_instances.png" width="800">
</p> </p>
In the opened form, choose parameters of the new instance such as: In the opened form, choose parameters of the new instance such as:
@ -97,7 +97,7 @@ In the opened form, choose parameters of the new instance such as:
* `Retention` period for stored metrics. * `Retention` period for stored metrics.
<p> <p>
<img src="/assets/images/managed/quickstart/quickstart-instance-create.png" width="800"> <img src="quickstart_instance-create.png" width="800">
</p> </p>
Once created, instance will remain for a short period of time in `PROVISIONING` status Once created, instance will remain for a short period of time in `PROVISIONING` status
@ -105,7 +105,7 @@ while the hardware spins-up, just wait for a couple of minutes and reload the pa
You'll also be notified via email once provisioning is finished: You'll also be notified via email once provisioning is finished:
<p> <p>
<img src="/assets/images/managed/quickstart/quickstart-instance-provisioning.png" width="800"> <img src="quickstart_instance-provisioning.png" width="800">
</p> </p>
## Access ## Access
@ -114,7 +114,7 @@ After transition from `PROVISIONING` to `RUNNING` state, VictoriaMetrics is full
and ready to accept write or read requests. But first, click on instance name to get the access token: and ready to accept write or read requests. But first, click on instance name to get the access token:
<p> <p>
<img src="/assets/images/managed/quickstart/quickstart-tokens.png" width="800"> <img src="quickstart_tokens.png" width="800">
</p> </p>
Access tokens are used in token-based authentication to allow an application to access the VictoriaMetrics API. Access tokens are used in token-based authentication to allow an application to access the VictoriaMetrics API.
@ -122,7 +122,7 @@ Supported token types are `Read-Only`, `Write-Only` and `Read-Write`. Click on t
to see usage examples: to see usage examples:
<p> <p>
<img src="/assets/images/managed/quickstart/quickstart-token-usage.png" width="800"> <img src="quickstart_token-usage.png" width="800">
</p> </p>
Follow usage example in order to configure access to VictoriaMetrics for your Prometheus, Follow usage example in order to configure access to VictoriaMetrics for your Prometheus,

Binary file not shown.

After

Width:  |  Height:  |  Size: 158 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 296 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 156 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 88 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 53 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 112 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 96 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 209 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 228 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 426 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 256 KiB

@ -95,7 +95,7 @@ You assign the role to the user during the user creation procedure. You can chan
It shows all users with different roles, and you can apply provided actions with them. It shows all users with different roles, and you can apply provided actions with them.
<p> <p>
<img src="/assets/images/managed/user-management/users-list.png" width="800"> <img src="user-managment_users-list.png" width="800">
</p> </p>
In the table, there is additional information about the users: In the table, there is additional information about the users:
@ -132,17 +132,17 @@ In the table, there is additional information about the users:
<span>Click on</span> <span>Click on</span>
<span> <span>
<img src="/assets/images/managed/user-management/invite-user-button.png" width="100" height="50"> <img src="user-managment_invite-user-button.png" width="100" height="50">
</span> </span>
the user invitation button and fill out the form in the modal, which will appear after you click. All fields are mandatory. the user invitation button and fill out the form in the modal, which will appear after you click. All fields are mandatory.
<p> <p>
<img src="/assets/images/managed/user-management/invite-user-modal.png" width="800"> <img src="user-managment_invite-user-modal.png" width="800">
</p> </p>
<span>After filling out the form, click on the</span> <span>After filling out the form, click on the</span>
<span> <span>
<img src="/assets/images/managed/user-management/invite-button.png" width="70" height="50"> <img src="user-managment_invite-button.png" width="70" height="50">
</span> </span>
button. The user will be saved, and an invitation email to the provided email address will be sent. As a confirmation, you will see the success message. button. The user will be saved, and an invitation email to the provided email address will be sent. As a confirmation, you will see the success message.
@ -151,39 +151,39 @@ button. The user will be saved, and an invitation email to the provided email ad
The user will be at Pending Invitation status. After accepting the invitation user status changes to Active. The user will be at Pending Invitation status. After accepting the invitation user status changes to Active.
<p> <p>
<img src="/assets/images/managed/user-management/success-invitation.png" width="800"> <img src="user-managment_success-invitation.png" width="800">
</p> </p>
## How to Update User ## How to Update User
<span>To edit the user role and details, activate or deactivate a user, and click on</span> <span>To edit the user role and details, activate or deactivate a user, and click on</span>
<span> <span>
<img src="/assets/images/managed/user-management/edit-user-btn.png" width="70" height="70"> <img src="user-managment_edit-user-btn.png" width="70" height="70">
</span> </span>
<span>or</span> <span>or</span>
<span> <span>
<img src="/assets/images/managed/user-management/edit-user-link.png" width="100" height="70"> <img src="user-managment_edit-user-link.png" width="100" height="70">
</span> </span>
to edit the user. to edit the user.
<p> <p>
<img src="/assets/images/managed/user-management/update-user-buttons.png" width="800"> <img src="user-managment_update-user-buttons.png" width="800">
</p> </p>
User editing form: User editing form:
<p> <p>
<img src="/assets/images/managed/user-management/update-user.png" width="800"> <img src="user-managment_update-user.png" width="800">
</p> </p>
<span>To save changes, click the</span> <span>To save changes, click the</span>
<span> <span>
<img src="/assets/images/managed/user-management/update-user-save-button.png" width="80" height="40"> <img src="user-managment_update-user-save-button.png" width="80" height="40">
</span> </span>
button. If changes are saved successfully, you will see a message at the top of the page. button. If changes are saved successfully, you will see a message at the top of the page.
<p> <p>
<img src="/assets/images/managed/user-management/update-user-success.png" width="800"> <img src="user-managment_update-user-success.png" width="800">
</p> </p>
## How to Delete User ## How to Delete User
@ -192,22 +192,22 @@ You can delete a user from your account. However, you will need to invite them a
<span>Click on</span> <span>Click on</span>
<span> <span>
<img src="/assets/images/managed/user-management/delete-user-btn.png" width="40" height="40"> <img src="user-managment_delete-user-btn.png" width="40" height="40">
</span> </span>
to delete the user. to delete the user.
<p> <p>
<img src="/assets/images/managed/user-management/delete-user-button.png" width="800"> <img src="user-managment_delete-user-button.png" width="800">
</p> </p>
To confirm the deletion of a user, you will need to re-enter their email address and press the **Delete** button To confirm the deletion of a user, you will need to re-enter their email address and press the **Delete** button
<p> <p>
<img src="/assets/images/managed/user-management/delete-user-confirm.png" width="800"> <img src="user-managment_delete-user-confirm.png" width="800">
</p> </p>
You will be redirected to the main page with a success or error message You will be redirected to the main page with a success or error message
<p> <p>
<img src="/assets/images/managed/user-management/delete-user-success.png" width="800"> <img src="user-managment_delete-user-success.png" width="800">
</p> </p>

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 76 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 289 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 288 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 301 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 329 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 281 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 297 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 307 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 185 KiB