tomkerkhove · tomkerkhove · Nov 27, 2019 · Nov 18, 2019 · Nov 19, 2019 · Nov 19, 2019
@@ -1,4 +1,8 @@
 {
     "default": true,
-    "MD013": { "code_blocks": false, "tables": false }
+    "MD013": { "code_blocks": false, "tables": false },
+    "MD041": false,
+    "MD026": false,
+    "MD033": false,
+    "MD001": false
 }
@@ -1,21 +1,23 @@
 ---
-title:
 subtitle: created on {{ now.Format "2006-01-02" }}
 date: 2018-09-02T20:46:47+02:00
-removal_date: 2019-07-07
 weight:
 version:
 ---
 
 #### Swagger 2.0
 
-Lorem markdownum fulmen repetita atro praecipitem tela accepto quantumque
-funeribus spes; casus memorabile. [Concidit culmine](http://ora-tyria.net/),
-unda ad **adhuc** liquidi cognata, sua cetera; ceu iam facientia quem. Regina
-referre tibi places cum et meritorum, **in atque**, capillos et deos. Di sua
-cepit excidit pectore probarunt fatale muta vento in Tamasenum.
+###### Deprecated as of v1.1 and will be removed in v2.0
 
-Templa hunc, exosa felix os temerasse Boreas facies nam ferre regimen! Fidemque
-signans stant Volturnus dicta vides, utque caelo pallidiora.
+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.
 
-Tandem stat surgis. Rerum nati arbitrio, nactusque dilectos a!
+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.
+
+**Impact:** Migration is required - API documentation will no longer be available.
+
+**Alternative:** Use API documentation provided in OpenAPI v3.0 format.
+
+**Discussion:** [GitHub Issue #782](https://github.com/tomkerkhove/promitor/issues/782)
@@ -9,13 +9,17 @@ version:
 
 #### Swagger UI 2.0
 
-Lorem markdownum fulmen repetita atro praecipitem tela accepto quantumque
-funeribus spes; casus memorabile. [Concidit culmine](http://ora-tyria.net/),
-unda ad **adhuc** liquidi cognata, sua cetera; ceu iam facientia quem. Regina
-referre tibi places cum et meritorum, **in atque**, capillos et deos. Di sua
-cepit excidit pectore probarunt fatale muta vento in Tamasenum.
+###### Deprecated as of v1.1 and will be removed in v2.0
 
-Templa hunc, exosa felix os temerasse Boreas facies nam ferre regimen! Fidemque
-signans stant Volturnus dicta vides, utque caelo pallidiora.
+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.
 
-Tandem stat surgis. Rerum nati arbitrio, nactusque dilectos a!
+We've added support for OpenAPI 3.0 in Promitor v1.1 next to Swagger 2.0 along with
+OpenAPI UI 3.0.
+
+**Impact:** Migration is required - Swagger UI 2.0 will no longer be available.
+
+**Alternative:** Use OpenAPI UI 3.0.
+
+**Discussion:** [GitHub Issue #781](https://github.com/tomkerkhove/promitor/issues/781)
@@ -5,6 +5,7 @@ weight: 1
 version:
 ---
 
-- {{% tag added %}} Add a test for template variable overwrite
-- {{% tag changed %}} `Update to Go` 1.11
-
+- {{% tag added %}} Azure SQL Database Scraper ([docs](https://promitor.io/configuration/v1.x/metrics/sql-database) | [#317](https://github.com/tomkerkhove/promitor/issues/317))
+- {{% tag added %}} OpenAPI v3.0 support (`/api/v1/docs.json` | [#734](https://github.com/tomkerkhove/promitor/issues/734))
+- {{% tag added %}} OpenAPI UI based on OpenAPI v3.0 (`/api/docs/` | [#734](https://github.com/tomkerkhove/promitor/issues/734))
+- {{% tag changed %}} Helm Chart creates apps/v1 Deployment instead of v1beta1 ([#669](https://github.com/tomkerkhove/promitor/issues/669))
@@ -0,0 +1,15 @@
+---
+subtitle: "released on 2018-09-19"
+date: 2018-09-19T20:46:47+02:00
+weight: 020
+version: v0.2.0
+---
+
+- {{% tag added %}} Generic Scaper ([#63](https://github.com/tomkerkhove/promitor/issues/63))
+- {{% tag added %}} Track exceptions in Azure Application Insights ([docs](https://promitor.io/configuration/v0.x/#external-providers) | [#82](https://github.com/tomkerkhove/promitor/issues/82))
+- {{% tag added %}} Runtime validation for Azure authentication on startup ([#110](https://github.com/tomkerkhove/promitor/issues/110))
+- {{% tag changed %}} Upgrade to .NET Core 2.1 ([#83](https://github.com/tomkerkhove/promitor/issues/83))
+- {{% tag changed %}} Migrate to Microsoft.Azure.Management.Monitor.Fluent instead of Microsoft.Azure.Management.Monitor ([#83](https://github.com/tomkerkhove/promitor/issues/83))
+- {{% tag changed %}} `Configuration_Get` operation now returns enum strings for resourceType, not integers
+
+Full release notes can be found [here](https://github.com/tomkerkhove/promitor/releases/tag/0.2.0).
@@ -0,0 +1,10 @@
+---
+subtitle: "released on 2018-09-23"
+date: 2018-09-23T20:46:47+02:00
+weight: 021
+version: v0.2.1
+---
+
+- {{% tag security %}} Mitigation for vulnerability CVE-2018-8409 ([announcement](https://github.com/aspnet/Announcements/issues/316) | [#167](https://github.com/tomkerkhove/promitor/issues/167))
+
+Full release notes can be found [here](https://github.com/tomkerkhove/promitor/releases/tag/0.2.1).
@@ -0,0 +1,11 @@
+---
+subtitle: "released on 2018-10-23"
+date: 2018-10-23T20:46:47+02:00
+weight: 030
+version: v0.3.0
+---
+
+- {{% tag security %}} Mitigation for vulnerability CVE-2018-8292 ([announcement](https://github.com/dotnet/announcements/issues/88) | [#189](https://github.com/tomkerkhove/promitor/issues/189))
+- {{% tag changed %}} Metrics filter for generic scraper is now optional ([#192](https://github.com/tomkerkhove/promitor/issues/192))
+
+Full release notes can be found [here](https://github.com/tomkerkhove/promitor/releases/tag/0.3.0).
@@ -0,0 +1,12 @@
+---
+subtitle: "released on 2018-12-10"
+date: 2018-12-10T20:46:47+02:00
+weight: 040
+version: v0.4.0
+---
+
+- {{% tag added %}} Container port is now configurable ([docs](https://promitor.io/configuration/v0.x/#runtime) | [#238](https://github.com/tomkerkhove/promitor/issues/238))
+- {{% tag added %}} Telemetry is sent to stdout & stderr ([docs](https://promitor.io/configuration/v0.x/#logging) | [#196](https://github.com/tomkerkhove/promitor/issues/196))
+- {{% tag added %}} New Health API endpoint ([docs](https://promitor.io/operations/#health) | [#9](https://github.com/tomkerkhove/promitor/issues/9))
+
+Full release notes can be found [here](https://github.com/tomkerkhove/promitor/releases/tag/0.4.0).
@@ -0,0 +1,12 @@
+---
+subtitle: "released on 2019-01-09"
+date: 2019-01-09T20:46:47+02:00
+weight: 041
+version: v0.4.1
+---
+
+- {{% tag changed %}} Upgrade to .NET Core 2.2.1 ([#267](https://github.com/tomkerkhove/promitor/issues/267))
+- {{% tag security %}} Mitigation for vulnerability CVE-2019-0548 ([announcement](https://github.com/aspnet/Announcements/issues/335) | [#267](https://github.com/tomkerkhove/promitor/issues/267))
+- {{% tag security %}} Mitigation for vulnerability CVE-2019-0564 ([announcement](https://github.com/aspnet/Announcements/issues/334) | [#267](https://github.com/tomkerkhove/promitor/issues/267))
+
+Full release notes can be found [here](https://github.com/tomkerkhove/promitor/releases/tag/0.4.1).
@@ -0,0 +1,10 @@
+---
+subtitle: "released on 2019-01-24"
+date: 2019-01-24T20:46:47+02:00
+weight: 050
+version: v0.5.0
+---
+
+- {{% tag added %}} Include timestamp information in metrics ([docs](https://promitor.io/configuration/v0.x/#scraping) | [#254](https://github.com/tomkerkhove/promitor/issues/254))
+
+Full release notes can be found [here](https://github.com/tomkerkhove/promitor/releases/tag/0.5.0).
@@ -0,0 +1,10 @@
+---
+subtitle: "released on 2019-02-06"
+date: 2019-02-06T20:46:47+02:00
+weight: 060
+version: v0.6.0
+---
+
+- {{% tag changed %}} Provide capability to opt-out of metric timestamps ([#290](https://github.com/tomkerkhove/promitor/issues/290))
+
+Full release notes can be found [here](https://github.com/tomkerkhove/promitor/releases/tag/0.6.0).
@@ -0,0 +1,41 @@
+---
+subtitle: "released on 2019-09-18"
+date: 2019-09-18T20:46:47+02:00
+weight: 100
+version: v1.0.0
+---
+
+- {{% tag added %}} Azure Cache for Redis Scraper
+([docs](https://promitor.io/configuration/v1.x/metrics/redis-cache) | [#335](https://github.com/tomkerkhove/promitor/issues/335))
+- {{% tag added %}} Azure Container Instances Scraper ([docs](https://promitor.io/configuration/v1.x/metrics/container-instances) | [#326](https://github.com/tomkerkhove/promitor/issues/326))
+- {{% tag added %}} Azure Container Registry Scraper ([docs](https://promitor.io/configuration/v1.x/metrics/container-registry) | [#325](https://github.com/tomkerkhove/promitor/issues/325))
+- {{% tag added %}} Azure Cosmos DB Scraper ([docs](https://promitor.io/configuration/v1.x/metrics/cosmos-db) | [#329](https://github.com/tomkerkhove/promitor/issues/329))
+- {{% tag added %}} Azure Database for PostgreSQL Scraper ([docs](https://promitor.io/configuration/v1.x/metrics/postgresql) | [#322](https://github.com/tomkerkhove/promitor/issues/322))
+- {{% tag added %}} Azure Storage Queue Scraper ([docs](https://promitor.io/configuration/v1.x/metrics/storage-queue) | [#64](https://github.com/tomkerkhove/promitor/issues/64))
+- {{% tag added %}} Azure VM Scraper ([docs](https://promitor.io/configuration/v1.x/metrics/virtual-machine) | [#309](https://github.com/tomkerkhove/promitor/issues/309))
+- {{% tag added %}} Azure Virtual Network Scraper ([docs](https://promitor.io/configuration/v1.x/metrics/network-interface) | [#330](https://github.com/tomkerkhove/promitor/issues/330))
+- {{% tag added %}} Provide labels for resource information per metric ([docs](https://promitor.io/metrics/labels) | [#598](https://github.com/tomkerkhove/promitor/issues/598))
+- {{% tag added %}} Provide capability to specify custom labels per metric ([docs](https://promitor.io/metrics/labels) | [#603](https://github.com/tomkerkhove/promitor/issues/603))
+- {{% tag added %}} Support runtime configuration YAML ([docs](https://promitor.io/configuration/v1.x/runtime) | [#431](https://github.com/tomkerkhove/promitor/issues/431))
+- {{% tag added %}} Provide `Get Runtime Configuration` API endpoint ([docs](https://promitor.io/operations/#configuration-rest-apis) | [#638](https://github.com/tomkerkhove/promitor/issues/638))
+- {{% tag added %}} Provide capability to configure the metric aggregation interval per metric ([docs](https://promitor.io/configuration/v1.x/metrics/) | [#256](https://github.com/tomkerkhove/promitor/issues/256))
+- {{% tag added %}} Provide capability to configure a default metric aggregation interval ([docs](https://promitor.io/configuration/v1.x/metrics/) | [#257](https://github.com/tomkerkhove/promitor/issues/257))
+- {{% tag added %}} Provide capability to configure the scraping interval per metric ([docs](https://promitor.io/configuration/v1.x/metrics/) | [#258](https://github.com/tomkerkhove/promitor/issues/258))
+- {{% tag added %}} Provide Kubernetes Helm Chart ([docs](https://promitor.io/deployment/#getting-the-helm-chart) | [#17](https://github.com/tomkerkhove/promitor/issues/17))
+- {{% tag added %}} Provide capability to influence unreported metric value ([docs](https://promitor.io/configuration/v1.x/runtime#prometheus-scraping-endpoint) | [#546](https://github.com/tomkerkhove/promitor/issues/546))
+- {{% tag added %}} Provide `promitor_ratelimit_arm` metric to report ARM throttling limit ([docs](https://promitor.io/operations/#azure-resource-manager-api---consumption--throttling) | [#199](https://github.com/tomkerkhove/promitor/issues/199))
+- {{% tag added %}} Provide support for scraping multiple resource groups ([docs](https://promitor.io/configuration/v1.x/metrics/) | [#294](https://github.com/tomkerkhove/promitor/issues/294))
+- {{% tag added %}} Provide capability to scrape multiple resources under on metrics, aggregated with labels per resource ([docs](https://promitor.io/configuration/v1.x/metrics/) | [#513](https://github.com/tomkerkhove/promitor/issues/513))
+- {{% tag added %}} End-to-end walkthrough how to deploy Promitor, Prometheus, and Grafana on an AKS Cluster ([walkthrough](https://promitor.io/walkthrough/))
+- {{% tag added %}} Ability to reduce logging output  ([docs](https://promitor.io/configuration/v1.x/runtime#telemetry) | [#551](https://github.com/tomkerkhove/promitor/issues/551))
+- {{% tag added %}} Provide timestamps in logging ([#571](https://github.com/tomkerkhove/promitor/issues/571))
+- {{% tag security %}} Mitigation for vulnerability CVE-2019-1302 ([announcement](https://github.com/aspnet/Announcements/issues/384) | [#706](https://github.com/tomkerkhove/promitor/issues/706))
+- {{% tag security %}} Mitigation for vulnerability CVE-2018-8269 ([announcement](https://github.com/aspnet/Announcements/issues/385) | [#707](https://github.com/tomkerkhove/promitor/issues/707))
+- {{% tag changed %}} Rename Docker image to `promitor-agent-scraper` ([docs](https://promitor.io/deployment/#docker) | [#393](https://github.com/tomkerkhove/promitor/issues/393))
+- {{% tag changed %}} Provide versioning for metrics declaration declaration ([docs](https://promitor.io/configuration/v1.x/metrics/#general-declaration) | [#646](https://github.com/tomkerkhove/promitor/issues/646))
+- {{% tag changed %}} Use Alphine as base Docker image instead of Debian ([#610](https://github.com/tomkerkhove/promitor/issues/610))
+- {{% tag changed %}} Default Prometheus endpoint is now /metrics ([docs](https://promitor.io/configuration/v1.x/runtime#prometheus-scraping-endpoint) | [#461](https://github.com/tomkerkhove/promitor/issues/461))
+- {{% tag changed %}} Move default scraping interval to metrics configuration ([docs](https://promitor.io/configuration/v1.x/metrics/#metric-defaults) | [#259](https://github.com/tomkerkhove/promitor/issues/259))
+- {{% tag changed %}} Provide information in health endpoint ([docs](https://promitor.io/operations/#health) | [#634](https://github.com/tomkerkhove/promitor/issues/634))
+
+Full release notes can be found [here](https://github.com/tomkerkhove/promitor/releases/tag/1.0.0).
@@ -1,9 +1,8 @@
 ---
-title: "Xenial Xerus"
 subtitle: "released on 2018-09-02"
-date: 2018-09-02T20:46:47+02:00
-weight: 15
-version: v1.15
+date: 2019-09-18T20:46:47+02:00
+weight: 100
+version: v1.0.0
 ---
 
 - {{% tag added %}} Add a test for template variable overwrite
@@ -13,4 +12,4 @@ version: v1.15
 - {{% tag removed %}} Add instruction to install PostCSS when missing
 - {{% tag security %}} Update snapcraft build config to Go 1.11
 
-
+Full release notes can be found [here](https://github.com/tomkerkhove/promitor/releases/tag/0.2.1).
@@ -1,3 +1,10 @@
+[Settings]
+# Added automatically by the Netlify CLI. It has no effect during normal 
+# Git-backed deploys.
+ID = "a8a22b94-477b-439e-9bc4-b98ae0af10cc"
+
+# Settings in the [build] context are global and are applied to all contexts 
+# unless otherwise overridden by more specific contexts.  
 [build]
 publish = "public"
 command = "hugo --gc --minify"

@@ -0,0 +1,91 @@
+# Deprecating A Feature
+
+This guide walks through the process for deprecating a feature.
+
+## Why? When? What now?!
+
+Deprecations are never fun so we should elaborate on why it's being deprecated
+and what the alternative is.
+
+Every deprecation should explicitly mention in what version it is getting
+deprecated and where it's being removed. Once removed, what is the impact?
+
+## Procedure
+
+Every feature that is being deprecated should follow this procedure:
+
+1. Open issue as deprecation notice
+    - Label it with `deprecation-notice` label
+    - Plan it for the next major release
+2. Document deprecated feature on [`changelog.promitor.io`](http://changelog.promitor.io/)
+3. Announce deprecation in [`📢 Promitor Updates`](https://github.com/tomkerkhove/promitor/issues/668)
+
+<details>
+<summary><b>Deprecation Template</b></summary>
+
+```yaml
+---
+title:
+subtitle: created on {{ now.Format "2006-01-02" }}
+date: 2018-09-02T20:46:47+02:00
+removal_date: 2019-07-07
+weight:
+version:
+---
+
+#### <title>
+###### Deprecated as of v<deprecation-version> and will be removed in v<removal-version>
+
+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.
+
+**Impact:** <impact>
+
+**Alternative:** <alternative>.
+
+**Discussion:** [GitHub Issue #<issue-number>](https://github.com/tomkerkhove/promitor/issues/<issue-number>)
+```
+
+</details>
+
+<details>
+<summary><b>Deprecation Announcement</b></summary>
+
+```markdown
+**<feature name> is being deprecated** as of <deprecation-version> and removed in <removal-version>.
+
+For more information, join the conversation in our [deprecation issue](<url-to-deprecation>).
+```
+
+</details>
+
+<details>
+<summary><b>Deprecation Notice</b></summary>
+
+```markdown
+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.
+Deprecated as of v<deprecation-version> and will be removed in v<removal-version>
+
+**Deprecated as of:**
+v<deprecation-version>
+
+**Will be removed in:**
+v<removal-version>
+
+**Impact:**
+<impact>
+
+**Alternative:**
+<alternative>.
+```
+
+</details>