← All dashboards

ArvanCloud CDN

ArvanCloud CDN Dashboard

ArvanCloud Prometheus exporter


It’s a Prometheus exporter that exposes metrics from ArvanCloud products. Currently, it supports the following products:

  • CDN
  • Object Storage
  • PaaS/CaaS (coming soon)
  • IaaS (coming soon)

How-to

You can run the exporter using Docker:

bash
cp config/config.test.yml config/config.yml
docker run -d \
    -p 9786:9786 \
    -v ./config/config.yml:/app/config.yml \
    r1cloud/exporter:v1.1.0

Configuration

This document provides an overview of the configuration options available in the project YAML file (config.yml).

Token

The token field is used to specify the API key for authentication. It should be kept secure and not shared publicly. You can read more about API keys in the ArvanCloud API documentation.

Example:

yaml
token: "apikey 87db6d20-1234-abcd-efgh-3a419c8b7479"

Products

The products section contains configurations for different product modules within the project.

CDN

yaml
products:
    cdn:
        enable: true
        domains:
            - "example.ir"
            - "example.com"
        period: 3h
  • enable: Set the enable field to true to activate the CDN collector.

  • domains: Specify the domains that should be included in report collection.

  • period: Set the period field to specify the time interval for your reports. For example, if you set the period to 3h, the exporter will collect the last 3 hours of data from the ArvanCloud API.

Metrics

The CDN collector exposes the following metrics:

NameDescriptionType
arvancloud_cdn_requestsNumber of requestsgauge
arvancloud_cdn_trafficTraffic served by ArvanCloud per typesgauge
arvancloud_cdn_visitorsNumber of unique visitorsgauge
arvancloud_cdn_high_request_ipsHigh request IPsgauge
arvancloud_cdn_requests_by_countryNumber of request by countrygauge
arvancloud_cdn_traffic_by_countryTraffic by countrygauge
arvancloud_cdn_response_timeResponse timegauge
arvancloud_cdn_requests_by_statusNumber of request by HTTP status codegauge

❗️Warning: The high-request-ips metric is available in Professional plan and higher.

❕Note: All metrics will be labeled with domain label.

Dashboard

You can use pre-defined dashboard 20105 to visualize your data or create your own dashboard.

CDN Dashboard

Contributing 🤝

We welcome contributions from the community. Please report any issues you find on the Issues page or send us an email at cdn@arvancloud.ir.


Object Storage

yaml
products:
    object:
        enable: true
        buckets:
            - "bucket1"
            - "bucket2"
  • enable: Set the enable field to true to activate the object storage collector.

  • buckets: Specify the buckets that should be included in bucket usage metrics report collection.

Metrics

The object storage collector exposes the following metrics:

NameDescriptionType
arvancloud_storage_modified_timeIndicates the most recent update time of the bucket usage in UTC (if it’s zero, it means there’s no usage for today)gauge
arvancloud_storage_total_object_countRepresents the total count of objects in bucketgauge
arvancloud_storage_multi_part_object_countRepresents the total count of multipart objectsgauge
arvancloud_storage_bucket_sizeRepresents the actual size of the bucket in bytesgauge
arvancloud_storage_bucket_downloadRepresents bucket downloads in bytesgauge
arvancloud_storage_bucket_uploadRepresents bucket uploads in bytesgauge
arvancloud_storage_bucket_request_countRepresents the total count of successful operations per operation_type labelgauge

❕Note: operation_type label in arvancloud_storage_bucket_request_count can be one of following types: put_object, get_object, delete_object, post_head & head_bucket.

❕Note: All metrics will be labeled with bucket label.

❕Note: Bucket usage data gets updated every 5 minutes.

Dashboard

You can use pre-defined dashboard 20106 to visualize your data or create your own dashboard.

CDN Dashboard

Contributing 🤝

We welcome contributions from the community. Please report any issues you find on the Issues page or send us an email at object-storage@arvancloud.ir.

Dashboard revisions

RevisionDecscriptionCreated

Reviews

Login or Sign up to write a review

Reviews from the community

Get this dashboard

Data source:

Dependencies:

Import the dashboard template:

or

Download JSON

Docs: Importing dashboards

Downloads: 10