Guides - Deploying VictoriaMetrics Single through the Linode Marketplace

VictoriaMetrics is a free open source time series database (TSDB) and monitoring solution that is designed to collect, store, and process real-time metrics. It supports the Prometheus pull model and various push protocols ( Graphite, InfluxDB, OpenTSDB) for data ingestion. It is optimized for storage with high-latency IO, low IOPS, and time series with high churn rate. For reading the data and evaluating alerting rules, VictoriaMetrics supports the PromQL, MetricsQL, and Graphite query languages.

This Marketplace App deploys VictoriaMetrics Single, a single server/node version that’s suitable for small and medium businesses and data monitoring needs. It can easily handle 10 million or more active time series data points on a single instance. VictoriaMetrics Single is fully autonomous and can be used as a long-term storage for time series.

Deploying a Marketplace App

The Linode Marketplace allows you to easily deploy software on a Compute Instance using the Cloud Manager. See Get Started with Marketplace Apps for complete steps.

1. Log in to the Cloud Manager and select the Marketplace link from the left navigation menu. This displays the Linode Create page with the Marketplace tab pre-selected.

2. Under the Select App section, select the app you would like to deploy.

3. Complete the form by following the steps and advice within the Creating a Compute Instance guide. Depending on the Marketplace App you selected, there may be additional configuration options available. See the Configuration Options section below for compatible distributions, recommended plans, and any additional configuration options available for this Marketplace App.

4. Click the Create Linode button. Once the Compute Instance has been provisioned and has fully powered on, wait for the software installation to complete. If the instance is powered off or restarted before this time, the software installation will likely fail.

To verify that the app has been fully installed, see Get Started with Marketplace Apps > Verify Installation. Once installed, follow the instructions within the Getting Started After Deployment section to access the application and start using it.

Note

Estimated deployment time: VictoriaMetrics should be fully installed within 5-10 minutes after the Compute Instance has finished provisioning.

Configuration Options

• Supported distributions: Ubuntu 20.04 LTS
• Recommended plan: All plan types and sizes can be used.

VictoriaMetrics Options

• Hostname (required): Enter a hostname for your new instance. See Configure a Custom Hostname for examples.

Getting Started after Deployment

Scraping metrics

VictoriaMetrics supports metrics scraping in the same way as Prometheus does. Check the configuration file to edit scraping targets. See more details about scraping at How to scrape Prometheus exporters. The configuration file is located on your new server at the following location: /etc/victoriametrics/single/scrape.yml.

By default, ports 8428, 2003, 4242, and 8089 are open to accept metrics from different protocols. It’s recommended to disable ports for protocols which are not needed. Ubuntu firewall can be used to easily disable access for specific ports.

Sending metrics

Besides scraping, VictoriaMetrics accepts write requests for various ingestion protocols. This deployment supports the following protocols:

• Datadog, Influx (telegraph), JSON, CSV, Prometheus on port :8428
• Graphite (statsd) on port :2003 tcp/udp
• OpenTSDB on port :4242
• Influx (telegraph) on port :8089 tcp/udp

See more details and examples in official documentation.

Accessing the Query Interface

VictoriaMetrics provides a user interface, called vmui for query troubleshooting and exploration. This allows you to explore query results through graphs and tables.

To access vmui, open the following URL in your browser, replacing ip-address with the IPv4 address of your new Compute Instance:

http://ip-address:8428/vmui

You can then enter your query, such as vm_app_uptime_seconds, and click the Execute Query button to generate a graph, json file, and table.

If you prefer to access the query using the command-line, you can use curl from your local computer. Open your terminal and run the following curl command, again replacing ip-address with the IPv4 address of your new Compute Instance:

curl -sg http://ip-address:8428/api/v1/query_range?query=vm_app_uptime_seconds | jq

Note

Currently, Linode does not manage software and systems updates for Marketplace Apps. It is up to the user to perform routine maintenance on software deployed in this fashion.

More Information

You may wish to consult the following resources for additional information on this topic. While these are provided in the hope that they will be useful, please note that we cannot vouch for the accuracy or timeliness of externally hosted materials.

• Victoriametrics
• VictoriaMetrics documentation
• Quick Start
• VictoriaMetrics Articles
• Grafana Dashboards for VictoriaMetrics