VictoriaMetrics Cloud is a hosted monitoring platform, where users can run the VictoriaMetrics that they know and love on AWS without the need to perform typical DevOps tasks such as proper configuration, monitoring, logs collection, access protection, software updates, backups, etc.
The document covers the following topics:
- Registration
- Adding a payment method
- Restoring a password
- Creating deployments
- Start writing and reading data
- Modifying an existing deployment
Registration #
Start your registration process by visiting the Sign Up page.
There are two different methods to create an account:
- Create an account via Google Auth service;
- Create an account by filling in a registration form.
Create an account via Google Auth service: #
Click
Continue with Google
button on the Sign Up pageYou will be automatically redirected to the main page of the VictoriaMetrics Cloud
Create an account by filling in a registration form: #
- Fill in your email, password and password confirmation on Sign Up page.
1.All fields are required. Any errors will be shown in the interface, so it is easy to understand what should be adjusted.
You will be redirected to the main page with a notification message to confirm your email.
![Signup success](../quick_start_signup_success.webp)
You will also receive an email with a confirmation link as shown on the picture below:
![Signup email confirm](../quick_start_signup_email_confirm.webp)
It is necessary to confirm your email address. Otherwise, you won’t be able to create a deployment.
After successful confirmation of your email address, you’ll be able to create your first deployment or add a payment method.
![Signup email confirmed](../quick_start_signup_email_confirmed.webp)
Adding a payment method #
Navigate to a Billing page or click on
Upgrade
button as shown below:Choose a payment method
Pay with a card #
Click on an
Add card
panel and fill in all the fields in the form and pressAdd card
buttonAn error message will appear if a card us invalid
Successfully added card will be shown on the page as follows:
Link your AWS billing account via AWS Marketplace #
When you need to unify your AWS billing, you can start a subscription on AWS Marketplace.
Click on the
Buy on AWS Marketplace
panel:You will be redirected to the VictoriaMetrics Cloud product page.
Click on
View purchase option
button, and you will be redirected to an AWS login page or to a subscribe page on AWS Marketplace.Go to the VictoriaMetrics Cloud product page and click
Continue to Subscribe
button:Press the
Subscribe
button:After that you will see a success message where you should click
Set up your account
button:You’ll be redirected back to VictoriaMetrics Cloud billing page:
Switching between payment methods #
If both payment methods are added, it is possible to easily switch between them. Click on the radio button like on the picture below and confirm the change:
![Change payment method](../change_payment_method.webp)
![Change payment method confirmation](../change_payment_confirmation.webp)
If the payment method was changed successfully, the following message will appear:
![Change payment method success](../change_payment_method_success.webp)
Password restoration #
If you forgot your password, it can be restored in the following way:
Click
Forgot password?
link on the Sign In page:Enter your email and click
Reset password
button:Follow the instructions sent to your email in order to get access to your VictoriaMetrics Cloud account:
Navigate to the Profile page by clicking the corresponding link in the top right corner:
Enter a new password on the Profile page and press
Save
:
Creating deployments #
On the Deployments page you will see a list of your existing deployments and will be able to manage them.
To create a deployment click on the button Start sending metrics
button:
![Create deployment start](../create_deployment_start.webp)
When you already have at least one deployment you can create a new one by clicking on the Create deployment
button:
![Create deployment continue](../create_deployment_continue.webp)
On the opened screen, choose parameters of your new deployment:
Deployment type
- Single - for affordable, performant single-node deployments;
- Cluster - for highly available and multi-tenant deployments;
Region
– AWS region where deployment will run;- Desired
storage capacity
for storing metrics (you always can expand disk size later); Retention
period for stored metrics.Size
of your deployment based on your needs
Also see the Tier Parameters and Flag Parameters Configuration. This document provides an overview of tier parameters and predefined flag settings for VictoriaMetrics Cloud.
![Create deployment form](../create_deployment_form.webp)
When all parameters are configured, click on the Create
button, and deployment will be created.
Once created, deployment will remain for a short period of time in PROVISIONING
status
while the hardware spins-up, just wait for a couple of minutes and reload the page.
You’ll also be notified via email once your deployment is ready to use:
![Create deployment created](../create_deployment_created.webp)
![Create deployment active email](../create_deployment_active_email.webp)
Start writing and reading data #
After transition from PROVISIONING
to RUNNING
state, VictoriaMetrics Cloud deployment is fully operational
and is ready to accept write and read requests.
Click on deployment name and navigate to the Access tab to get the access token:
![Deployment access](../deployment_access.webp)
Access tokens are used in token-based authentication to allow an application to access the VictoriaMetrics API.
Supported token types are Read-Only
, Write-Only
and Read-Write
. Click on token created by default
to see usage examples:
![Deployment access write example](../deployment_access_write_example.webp)
![Deployment access read example](../deployment_access_read_example.webp)
Follow usage examples in order to configure access to VictoriaMetrics for your Prometheus, Grafana or any other software.
Modifying an existing deployment #
Remember, you can always add, remove or modify existing deployment by changing its size or any parameters on the deployment’s page. It is important to know that downgrade for cluster is currently not available.
![Modify deployment](../modify_deployment.webp)
To discover additional configuration options click on Advanced Settings
button, so you should see the following:
![Modify deployment additional settings](../modify_deployment_additional_settings.webp)
In that section, additional params can be set:
Deduplication
defines interval when deployment leaves a single raw sample with the biggest timestamp per each discrete interval;Maintenance Window
when deployment should start an upgrade process if needed;Settings
allow to define different flags for the deployment:
Please note, such an update requires a deployment restart and may result in a short downtime for single-node deployments.