Promitor Changelog

2020-11-23

Helm 2.0

Deprecated as of v1.6 and will be removed in v2.0

Promitor provides Helm charts to simplify deployments on a Kubernetes cluster.

In November 2019, Helm 3 was announced which marked the end of Helm 2 which would be phased out in a year and no longer supported. Learn more about it in the official Helm deprecation timeline.

Because of this deprecation, Promitor will no longer support Helm 2.0 deployments out-of-the-box. They might still be working but won’t be our focus for versions as of Promitor 2.0.

Announcement: GitHub Issue

Impact: Migration is required - Helm 2.0 deployments might still be working but is no longer supported.

Alternative: Use Helm 3.0 by following Helm migration guide.

Discussion: GitHub Discussions

2020-05-15

Prometheus Legacy Configuration

Deprecated as of v1.6 and will be removed in v2.0

Promitor has added support for different metric sinks in v1.6 along with a Prometheus Scraping endpoint sink.

This scraping endpoint works the same way as before but has a different way of configuration which is more in line with other sinks.

Because of that we are removing support for the “legacy” Prometheus configuration and use a unified metric sink approach.

We’ve added support for Prometheus metric sink while maintaining the legacy approach until it’s being removed.

Announcement: GitHub Issue

Impact: Migration is required - Prometheus legacy configuration will no longer be available.

Alternative: Use our new metric sink concept.

Discussion: GitHub Discussions

2020-01-07

Swagger 2.0

Deprecated as of v1.1 and will be removed in v2.0

OpenAPI v3.0 has been released in 2017 which is the new industry standard. With Promitor, we want to support that standard and have decided to go forward with 3.0 instead of 2.0.

We’ve added support for OpenAPI 3.0 in Promitor v1.1 next to Swagger 2.0 so you can migrate to it before we remove 2.0 in Promitor v2.0.

Announcement: GitHub Issue

Impact: Migration is required - API documentation will no longer be available.

Alternative: Use API documentation provided in OpenAPI v3.0 format.

Discussion: GitHub Discussions

2020-01-07

Swagger UI 2.0

Deprecated as of v1.1 and will be removed in v2.0

OpenAPI v3.0 has been released in 2017 which is the new industry standard. With Promitor, we want to support that standard and have decided to go forward with 3.0 instead of 2.0.

We’ve added support for OpenAPI 3.0 in Promitor v1.1 next to Swagger 2.0 along with OpenAPI UI 3.0.

Announcement: GitHub Issue

Impact: Migration is required - Swagger UI 2.0 will no longer be available.

Alternative: Use OpenAPI UI 3.0.

Discussion: GitHub Discussions

  • added Support for resource discovery (docs | configuration | deployment)
  • added Support for scraping Azure Event Hubs (docs | #372)
  • added Support for scraping Azure Logic Apps (docs | #314).
  • added Support for scraping Azure Express Route circuits (docs | #1251 | Contributed by @bluepixbe 🎉).
  • added Support for scraping Azure Application Gateway (docs | #1251 | Contributed by @bluepixbe 🎉).
  • added Support for scraping Azure Network Gateway (docs | #1264 | Contributed by @bluepixbe 🎉).
  • added Support for scraping Azure Kubernetes Service (docs | #333 | Contributed by @jkataja 🎉).
  • added Support for using dimensions with Azure Service Bus (#808)
  • added New validation rule to ensure at least one resource or resource collection is configured to scrape
  • added Provide suggestions when unknown fields are found in the metrics config. (#1105 | Contributed by @adamconnelly 🎉).
  • added Add validation to ensure the scraping schedule is a valid Cron expression. (#1103 | Contributed by @adamconnelly 🎉).
  • added Provide support for pushing metrics to Atlassian Statuspage (docs | #1152)
  • added Provide suggestions when unknown fields are found in the metrics config. (#1105 | Contributed by @adamconnelly 🎉).
  • added New validation rule to ensure the scraping schedule is a valid Cron expression. (#1103).
  • added New validation rule to ensure declarative or dynamic discovery for metrics to scrape are configured
  • added New System API endpoint giving runtime information (docs | #1208)
  • added Provide X-Version response header for API endpoints (#1209)
  • added Provide capability to tweak liveness/readines probes in Helm charts (#1350)
  • changed Show Promitor version during startup
  • changed Provide capability to scrape all queues in Azure Service Bus, instead of having to declare the queue name. (#529).
  • changed Handle validation failures on startup more gracefully. (#1113 | Contributed by @adamconnelly 🎉).
  • changed Improve time series handling to ensure finalized time series are reported
  • changed service.exposeExternally is renamed to service.loadBalancer.enabled in Promitor Agent Helm chart
  • changed Default name for rbac.serviceAccount.name is now promitor-scraper in Promitor Agent Helm chart
  • fixed Ensure Prometheus metric sink does write timestamps (#1217).
  • fixed Dimensions with / in name are now supported by replacing it with _ for Prometheus metric sink (#1248).
  • fixed (Multi-Dimensional) Metrics that do not have a value/time series are not reported correctly in Prometheus metric sink with metricSinks.prometheusScrapingEndpoint.metricUnavailableValue (#1197 | FAQ).
  • removed Support for Prometheus legacy configuration (deprecation notice | migration guide)
  • removed Support for Helm 2.0 (deprecation notice | Helm migration guide)
  • removed Support for Swagger UI 2.0 (deprecation notice | migration guide)
  • removed Support for Swagger 2.0 (deprecation notice | migration guide)
  • removed service.labelType & service.selectorType are no longer available in Promitor Scraper Helm chart

Learn how to migrate to 2.0 with our migration guide.

Scraper (Agent) - v1.6.1

released on 2020-06-01
  • fixed Ensure scraping jobs have unique names to ensure all resources are scraped
  • fixed Service Bus queue metrics are not reported correctly for entities in same namespace (#1050)
  • fixed ratelimit_arm reported instead of promitor_ratelimit_arm for Prometheus sink (#1056)
  • fixed Runtime config for metrics sinks is not working correctly (#1052)
  • removed Default Prometheus configuration since we have multiple metric sinks nowadays. We are removing this since you cannot have duplicate Prometheus scraping endpoints. If you omit legacy configuration it will use /metrics as a default value which forces you to use different endpoint in the Prometheus metric sink.

Full release notes can be found here.

Scraper (Agent) - v1.6.0

released on 2020-05-15

Full release notes can be found here.

Scraper (Agent) - v1.5.0

released on 2020-04-06
  • added Support for scraping multiple subscriptions (docs | #761)

Full release notes can be found here.

Scraper (Agent) - v1.4.0

released on 2020-03-20
  • added Support for Helm 3 (Helm Hub)
  • added Support for Windows containers (docs | image tagging strategy | #67)
  • added Support Prometheus service discovery in Helm chart (#861)
  • added Capability to gain insights on Azure Monitor integration (docs | #848)
  • changed Improve metrics configuration validation (#592 | Contributed by @adamconnelly 🎉)

Full release notes can be found here.

Scraper (Agent) - v1.3.0

released on 2020-01-30

Full release notes can be found here.

Scraper (Agent) - v1.2.1

released on 2020-01-15
  • security Patch for CVE-2020-0602 ASP.NET Core Denial of Service Vulnerability (notice)
  • security Patch for CVE-2020-0603 ASP.NET Core Remote Code Execution Vulnerability (notice)
  • fixed Correctly expose OpenAPI 3.0 documentation & UI (issue)

Full release notes can be found here.

Scraper (Agent) - v1.2.0

released on 2020-01-10
  • added Azure Virtual Machine Scale Set Scraper (docs | #310)
  • added Azure App Plan Scraper (docs | #315)
  • added Azure Web App Scraper (docs | #762)
  • added Azure Function App Scraper (docs | #366)
  • changed Metric labels for dimensions are now always lower-cased

Full release notes can be found here.

Scraper (Agent) - v1.1.0

released on 2020-01-07
  • added Support for all Azure clouds (docs | FAQ | #114)
  • added Multi-dimensional metric support (docs | FAQ | #81)
  • added Azure SQL Database Scraper (docs | #317 | Contributed by @adamconnelly 🎉)
  • added Azure SQL Managed Instance Scraper (docs | #381)
  • added OpenAPI v3.0 support (/api/v1/docs.json | docs | #734)
  • added OpenAPI UI based on OpenAPI v3.0 (/api/docs/ | docs | #734)
  • added Provide traces in Azure Application Insights (docs | #29)
  • added Introduce Frequently asked questions (FAQs) in documentation (FAQs)
  • changed Helm Chart creates apps/v1 Deployment instead of v1beta1 (#669 | Contributed by @ekeih 🎉)
  • changed Provide exceptions in Azure Application Insights for all exceptions, not just scraping (docs | #29)

Full release notes can be found here.

Scraper (Agent) - v1.0.0

released on 2019-09-18
  • added Azure Cache for Redis Scraper (docs | #335 | Contributed by @jcorioland 🎉)
  • added Azure Container Instances Scraper (docs | #326)
  • added Azure Container Registry Scraper (docs | #325)
  • added Azure Cosmos DB Scraper (docs | #329 | Contributed by @cesar-younes 🎉)
  • added Azure Database for PostgreSQL Scraper (docs | #322 | Contributed by @jcorioland 🎉)
  • added Azure Storage Queue Scraper (docs | #64 | Contributed by @michaelkruglos 🎉)
  • added Azure VM Scraper (docs | #309 | Contributed by @melmaliacone 🎉)
  • added Azure Virtual Network Scraper (docs | #330 | Contributed by @rguthriemsft 🎉)
  • added Provide labels for resource information per metric (docs | #598)
  • added Provide capability to specify custom labels per metric (docs | #603)
  • added Support runtime configuration YAML (docs | #431)
  • added Provide Get Runtime Configuration API endpoint (docs | #638)
  • added Provide capability to configure the metric aggregation interval per metric (docs | #256)
  • added Provide capability to configure a default metric aggregation interval (docs | #257)
  • added Provide capability to configure the scraping interval per metric (docs | #258 | Contributed by @brandonh-msft 🎉)
  • added Provide Kubernetes Helm Chart (docs | #17 | Contributed by @lee0c, @cnadolny, @immuzz 🎉)
  • added Provide capability to influence unreported metric value (docs | #546)
  • added Provide promitor_ratelimit_arm metric to report ARM throttling limit (docs | #199)
  • added Provide support for scraping multiple resource groups (docs | #294 | Contributed by @brusMX 🎉)
  • added Provide capability to scrape multiple resources under on metrics, aggregated with labels per resource (docs | #513 | Contributed by @adamconnelly 🎉)
  • added End-to-end walkthrough how to deploy Promitor, Prometheus, and Grafana on an AKS Cluster (walkthrough)
  • added Ability to reduce logging output (docs | #551)
  • added Provide timestamps in logging (#571)
  • security Mitigation for vulnerability CVE-2019-1302 (announcement | #706)
  • security Mitigation for vulnerability CVE-2018-8269 (announcement | #707)
  • changed Rename Docker image to promitor-agent-scraper (docs | #393)
  • changed Provide versioning for metrics declaration declaration (docs | #646)
  • changed Use Alphine as base Docker image instead of Debian (#610)
  • changed Default Prometheus endpoint is now /metrics (docs | #461)
  • changed Move default scraping interval to metrics configuration (docs | #259 | Contributed by @brandonh-msft 🎉)
  • changed Provide information in health endpoint (docs | #634)

Full release notes can be found here.

Scraper (Agent) - v0.6.0

released on 2019-02-06
  • changed Provide capability to opt-out of metric timestamps (#290)

Full release notes can be found here.