Skip to content

Migrate from Promitor Scraper 1.x to 2.x

Here is a migration guide from Promitor Scraper v1.x to v2.x.

For a complete overview of our changelog, we recommend going to changelog.promitor.io.

Migrate to new metric sink concept

As of Promitor Scraper v1.6 we have introduced the concept of metric sinks allowing you to emit scraped Azure Monitor metrics to multiple systems.

With Promitor v2.0, we are removing support for our legacy Prometheus configuration.

When using the following configuration:

prometheus:
  metricUnavailableValue: NaN
  enableMetricTimestamps: false
  scrapeEndpoint:
    baseUriPath: /metrics

You can easily migrate it to our Prometheus Scraping endpoint sink as following:

metricSinks:
  prometheusScrapingEndpoint:
    metricUnavailableValue: NaN
    enableMetricTimestamps: false
    baseUriPath: /metrics

For more information, we recommend reading our documentation concerning our Prometheus Scraping endpoint.

Migrate from Azure Service Bus Queue scraper to our new Azure Service Bus Namespace scraper

Since Azure Service Bus Queue scraper allows you to report metrics for all entities we decided to change the resource type from ServiceBusQueue to ServiceBusNamespace since it will also report metrics for topics, and not only queues.

For example:

name: azure_service_bus_queue_active_messages
description: "The number of active messages on a service bus queue"
resourceType: ServiceBusNamespace
azureMetricConfiguration:
  metricName: ActiveMessages
  aggregation:
    type: Total
resources:
- namespace: promitor-messaging
  # queueName: orders <-- Optionally specify the queue name to filter on
  # topicName: sales <-- Optionally specify the queue name to filter on
resourceDiscoveryGroups: # Optional, requires Promitor Resource Discovery agent (https://promitor.io/concepts/how-it-works#using-resource-discovery)
- name: service-bus-landscape

For more information, we recommend reading our documentation concerning our Azure Service Bus Namespace scraper.

Migrate to OpenAPI 3.0 & UI

All Promitor APIs have been migrated from Swagger to OpenAPI 3.0 specification.

Before, our Swagger docs were accessible via:

  • Swagger UI on /swagger
  • Raw documentation on /swagger/v1/swagger.json

Our OpenAPI 3.0 docs are available on:

  • Swagger UI on /api/docs
  • Raw documentation on /api/v1/docs.json

← back