From c0904f5296d70869d7e7c756844bff60e2e0241a Mon Sep 17 00:00:00 2001 From: Tom Kerkhove Date: Mon, 18 Nov 2019 12:16:01 +0100 Subject: [PATCH 01/12] Add unreleased aspects of Promitor v1.1 --- changelog/content/experimental/ex.md.sample | 10 ---------- changelog/content/experimental/ex2.md.sample | 9 --------- changelog/content/experimental/unreleased.md | 7 ++++--- 3 files changed, 4 insertions(+), 22 deletions(-) delete mode 100644 changelog/content/experimental/ex.md.sample delete mode 100644 changelog/content/experimental/ex2.md.sample diff --git a/changelog/content/experimental/ex.md.sample b/changelog/content/experimental/ex.md.sample deleted file mode 100644 index 33d30b81f..000000000 --- a/changelog/content/experimental/ex.md.sample +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "(2018-09-15)" -date: 2018-09-02T20:46:47+02:00 -weight: 1 -version: ---- - -- {{% tag added %}} Add a test for template variable overwrite -- {{% tag changed %}} `Update to Go` 1.11 - diff --git a/changelog/content/experimental/ex2.md.sample b/changelog/content/experimental/ex2.md.sample deleted file mode 100644 index 11d48e779..000000000 --- a/changelog/content/experimental/ex2.md.sample +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "(2018-09-15)" -date: 2018-09-02T20:46:47+02:00 -weight: 1 -version: ---- - -- {{% tag fixed %}} Space between `ul` elements -- {{% tag performance %}} It is now 1337 times faster diff --git a/changelog/content/experimental/unreleased.md b/changelog/content/experimental/unreleased.md index 33d30b81f..1f50930c7 100644 --- a/changelog/content/experimental/unreleased.md +++ b/changelog/content/experimental/unreleased.md @@ -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)) From b211879827de7f00901ab5620cf0ecaedd747586 Mon Sep 17 00:00:00 2001 From: Tom Kerkhove Date: Tue, 19 Nov 2019 16:10:18 +0100 Subject: [PATCH 02/12] 0.2 - 0.4.1 Signed-off-by: Tom Kerkhove --- changelog/content/released/v0.2.0.md | 15 +++++++++++++++ changelog/content/released/v0.2.1.md | 10 ++++++++++ changelog/content/released/v0.3.0.md | 11 +++++++++++ changelog/content/released/v0.4.0.md | 10 ++++++++++ changelog/content/released/v0.4.1.md | 12 ++++++++++++ 5 files changed, 58 insertions(+) create mode 100644 changelog/content/released/v0.2.0.md create mode 100644 changelog/content/released/v0.2.1.md create mode 100644 changelog/content/released/v0.3.0.md create mode 100644 changelog/content/released/v0.4.0.md create mode 100644 changelog/content/released/v0.4.1.md diff --git a/changelog/content/released/v0.2.0.md b/changelog/content/released/v0.2.0.md new file mode 100644 index 000000000..7318b292f --- /dev/null +++ b/changelog/content/released/v0.2.0.md @@ -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). \ No newline at end of file diff --git a/changelog/content/released/v0.2.1.md b/changelog/content/released/v0.2.1.md new file mode 100644 index 000000000..b6aa4fcca --- /dev/null +++ b/changelog/content/released/v0.2.1.md @@ -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). \ No newline at end of file diff --git a/changelog/content/released/v0.3.0.md b/changelog/content/released/v0.3.0.md new file mode 100644 index 000000000..65b5aa66c --- /dev/null +++ b/changelog/content/released/v0.3.0.md @@ -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). diff --git a/changelog/content/released/v0.4.0.md b/changelog/content/released/v0.4.0.md new file mode 100644 index 000000000..de8aa6967 --- /dev/null +++ b/changelog/content/released/v0.4.0.md @@ -0,0 +1,10 @@ +--- +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) | [#196](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))* diff --git a/changelog/content/released/v0.4.1.md b/changelog/content/released/v0.4.1.md new file mode 100644 index 000000000..077d7d299 --- /dev/null +++ b/changelog/content/released/v0.4.1.md @@ -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). From d045e577d9587a99c503d1aba273b6f658c115a3 Mon Sep 17 00:00:00 2001 From: Tom Kerkhove Date: Tue, 19 Nov 2019 16:26:43 +0100 Subject: [PATCH 03/12] Update history except for v1.0 Signed-off-by: Tom Kerkhove --- changelog/content/released/v0.4.0.md | 4 +++- changelog/content/released/v0.5.0.md | 10 ++++++++++ changelog/content/released/v0.6.0.md | 10 ++++++++++ changelog/content/released/v1.1.md | 10 ---------- changelog/content/released/v1.2.md | 8 -------- changelog/content/released/v1.3.md | 9 --------- changelog/content/released/v1.4.md | 10 ---------- .../content/released/{v1.15.md => vx.x.x.md.template} | 9 ++++----- 8 files changed, 27 insertions(+), 43 deletions(-) create mode 100644 changelog/content/released/v0.5.0.md create mode 100644 changelog/content/released/v0.6.0.md delete mode 100644 changelog/content/released/v1.1.md delete mode 100644 changelog/content/released/v1.2.md delete mode 100644 changelog/content/released/v1.3.md delete mode 100644 changelog/content/released/v1.4.md rename changelog/content/released/{v1.15.md => vx.x.x.md.template} (72%) diff --git a/changelog/content/released/v0.4.0.md b/changelog/content/released/v0.4.0.md index de8aa6967..5ffbc3655 100644 --- a/changelog/content/released/v0.4.0.md +++ b/changelog/content/released/v0.4.0.md @@ -5,6 +5,8 @@ weight: 040 version: v0.4.0 --- -- {{% tag added %}} Container port is now configurable *([docs](https://promitor.io/configuration/v0.x/#runtime) | [#196](https://github.com/tomkerkhove/promitor/issues/238))* +- {{% 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). diff --git a/changelog/content/released/v0.5.0.md b/changelog/content/released/v0.5.0.md new file mode 100644 index 000000000..1d8788e34 --- /dev/null +++ b/changelog/content/released/v0.5.0.md @@ -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). diff --git a/changelog/content/released/v0.6.0.md b/changelog/content/released/v0.6.0.md new file mode 100644 index 000000000..4a0311b45 --- /dev/null +++ b/changelog/content/released/v0.6.0.md @@ -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). diff --git a/changelog/content/released/v1.1.md b/changelog/content/released/v1.1.md deleted file mode 100644 index 08f86af97..000000000 --- a/changelog/content/released/v1.1.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "(2018-08-15)" -date: 2018-09-02T20:46:47+02:00 -weight: 1 -version: v1.1 ---- - -- {{% tag fixed %}} Keep end tags -- {{% tag added %}} Fix permissions when creating new folders -- {{% tag fixed %}} Fix handling of taxonomy terms containing slashes diff --git a/changelog/content/released/v1.2.md b/changelog/content/released/v1.2.md deleted file mode 100644 index 58f7f5f9c..000000000 --- a/changelog/content/released/v1.2.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: "(2018-08-17)" -date: 2018-09-02T20:46:47+02:00 -weight: 2 -version: v1.2 ---- - -- {{% tag fixed %}} Skip installing postcss due to failure on build server diff --git a/changelog/content/released/v1.3.md b/changelog/content/released/v1.3.md deleted file mode 100644 index 05117ea0a..000000000 --- a/changelog/content/released/v1.3.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "Trusty Tahr" -date: 2018-09-02T20:46:47+02:00 -weight: 3 -version: v1.3 ---- - -- {{% tag fixed %}} Fix .Site.Params case regression -- {{% tag fixed %}} Do not strip IE conditional statements diff --git a/changelog/content/released/v1.4.md b/changelog/content/released/v1.4.md deleted file mode 100644 index d4e6bb9f8..000000000 --- a/changelog/content/released/v1.4.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "" -subtitle: "released on 2018-08-21" -date: 2018-09-02T20:46:47+02:00 -weight: 4 -version: v1.4 ---- - -- {{% tag removed %}} Remove unused files from Git, Perl, etc. -- {{% tag added %}} Add nodejs to allow PostCSS to work diff --git a/changelog/content/released/v1.15.md b/changelog/content/released/vx.x.x.md.template similarity index 72% rename from changelog/content/released/v1.15.md rename to changelog/content/released/vx.x.x.md.template index 2f5afecc3..7f41faebf 100644 --- a/changelog/content/released/v1.15.md +++ b/changelog/content/released/vx.x.x.md.template @@ -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). From c3bcebf69f88dfd8f1afdadfa44894f2e8a32457 Mon Sep 17 00:00:00 2001 From: Tom Kerkhove Date: Thu, 21 Nov 2019 19:41:08 +0100 Subject: [PATCH 04/12] Disable Markdown rule MD026 --- .markdownlint.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.markdownlint.json b/.markdownlint.json index da8de5d38..7eddc2f48 100644 --- a/.markdownlint.json +++ b/.markdownlint.json @@ -1,4 +1,5 @@ { "default": true, - "MD013": { "code_blocks": false, "tables": false } + "MD013": { "code_blocks": false, "tables": false }, + "MD026": false } \ No newline at end of file From 11231fe1a0129784b79ec687e6583e35fae269a5 Mon Sep 17 00:00:00 2001 From: Tom Kerkhove Date: Thu, 21 Nov 2019 19:42:42 +0100 Subject: [PATCH 05/12] Define deprecation process without templates Signed-off-by: Tom Kerkhove --- deprecating-a-feature.md | 60 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 deprecating-a-feature.md diff --git a/deprecating-a-feature.md b/deprecating-a-feature.md new file mode 100644 index 000000000..498328d1f --- /dev/null +++ b/deprecating-a-feature.md @@ -0,0 +1,60 @@ +# 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` 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) + +## Deprecation Notice + +```markdown +``` + +## Deprecation Template + +```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: +--- + +#### 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. + +Templa hunc, exosa felix os temerasse Boreas facies nam ferre regimen! Fidemque +signans stant Volturnus dicta vides, utque caelo pallidiora. + +Tandem stat surgis. Rerum nati arbitrio, nactusque dilectos a! +``` + +## Deprecation Announcement + +```markdown +** is being deprecated** as of and removed in . + +For more information, join the conversation in our [deprecation issue](). +``` From 2b8f429f951a7232df3ee3e5bd78c07e24358675 Mon Sep 17 00:00:00 2001 From: Tom Kerkhove Date: Mon, 25 Nov 2019 15:12:47 +0100 Subject: [PATCH 06/12] Use different site --- changelog/netlify.toml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/changelog/netlify.toml b/changelog/netlify.toml index e64bfa7f9..ec0a64ebb 100644 --- a/changelog/netlify.toml +++ b/changelog/netlify.toml @@ -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" From ad8006b43fc71ddfe27912b2c80a157894de3255 Mon Sep 17 00:00:00 2001 From: Tom Kerkhove Date: Tue, 26 Nov 2019 13:14:00 +0100 Subject: [PATCH 07/12] Swagger deprecations --- changelog/content/deprecated/swagger-2.0.md | 24 +++++++++---------- .../content/deprecated/swagger-ui-2.0.md | 19 ++++++++------- 2 files changed, 23 insertions(+), 20 deletions(-) diff --git a/changelog/content/deprecated/swagger-2.0.md b/changelog/content/deprecated/swagger-2.0.md index 1dfda4363..4cbf642db 100644 --- a/changelog/content/deprecated/swagger-2.0.md +++ b/changelog/content/deprecated/swagger-2.0.md @@ -1,21 +1,21 @@ --- -title: subtitle: created on {{ now.Format "2006-01-02" }} date: 2018-09-02T20:46:47+02:00 -removal_date: 2019-07-07 -weight: -version: +removal_date: --- #### Swagger 2.0 +###### Deprecated as of v1.1 and will be removed in v2.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. +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. -Templa hunc, exosa felix os temerasse Boreas facies nam ferre regimen! Fidemque -signans stant Volturnus dicta vides, utque caelo pallidiora. +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. -Tandem stat surgis. Rerum nati arbitrio, nactusque dilectos a! +**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) diff --git a/changelog/content/deprecated/swagger-ui-2.0.md b/changelog/content/deprecated/swagger-ui-2.0.md index 9451c48f1..f8011ce68 100644 --- a/changelog/content/deprecated/swagger-ui-2.0.md +++ b/changelog/content/deprecated/swagger-ui-2.0.md @@ -8,14 +8,17 @@ version: --- #### Swagger UI 2.0 +###### Deprecated as of v1.1 and will be removed in v2.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. +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. -Templa hunc, exosa felix os temerasse Boreas facies nam ferre regimen! Fidemque -signans stant Volturnus dicta vides, utque caelo pallidiora. +We've added support for OpenAPI 3.0 in Promitor v1.1 next to Swagger 2.0 along with +OpenAPI UI 3.0. -Tandem stat surgis. Rerum nati arbitrio, nactusque dilectos a! +**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) \ No newline at end of file From 7c00432920e8858c4be28f802081986dacc62872 Mon Sep 17 00:00:00 2001 From: Tom Kerkhove Date: Tue, 26 Nov 2019 13:15:51 +0100 Subject: [PATCH 08/12] Formatting Signed-off-by: Tom Kerkhove --- .markdownlint.json | 5 ++++- changelog/content/deprecated/swagger-2.0.md | 4 +++- changelog/content/deprecated/swagger-ui-2.0.md | 1 + 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/.markdownlint.json b/.markdownlint.json index 7eddc2f48..503463328 100644 --- a/.markdownlint.json +++ b/.markdownlint.json @@ -1,5 +1,8 @@ { "default": true, "MD013": { "code_blocks": false, "tables": false }, - "MD026": false + "MD041": false, + "MD026": false, + "MD033": false, + "MD001": false } \ No newline at end of file diff --git a/changelog/content/deprecated/swagger-2.0.md b/changelog/content/deprecated/swagger-2.0.md index 4cbf642db..297f88d69 100644 --- a/changelog/content/deprecated/swagger-2.0.md +++ b/changelog/content/deprecated/swagger-2.0.md @@ -1,10 +1,12 @@ --- subtitle: created on {{ now.Format "2006-01-02" }} date: 2018-09-02T20:46:47+02:00 -removal_date: +weight: +version: --- #### 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. diff --git a/changelog/content/deprecated/swagger-ui-2.0.md b/changelog/content/deprecated/swagger-ui-2.0.md index f8011ce68..007be8c8d 100644 --- a/changelog/content/deprecated/swagger-ui-2.0.md +++ b/changelog/content/deprecated/swagger-ui-2.0.md @@ -8,6 +8,7 @@ version: --- #### 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. From 7e651744ebd472707a1dea73245b4a40d78cfdf8 Mon Sep 17 00:00:00 2001 From: Tom Kerkhove Date: Tue, 26 Nov 2019 13:16:09 +0100 Subject: [PATCH 09/12] Provide deprecation guide Signed-off-by: Tom Kerkhove --- deprecating-a-feature.md | 65 +++++++++++++++++++++++++++++----------- 1 file changed, 48 insertions(+), 17 deletions(-) diff --git a/deprecating-a-feature.md b/deprecating-a-feature.md index 498328d1f..b12b83fb5 100644 --- a/deprecating-a-feature.md +++ b/deprecating-a-feature.md @@ -15,17 +15,13 @@ deprecated and where it's being removed. Once removed, what is the impact? Every feature that is being deprecated should follow this procedure: 1. Open issue as deprecation notice - - Label it with `deprecation` label + - 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) -## Deprecation Notice - -```markdown -``` - -## Deprecation Template +
+Deprecation Template ```yaml --- @@ -37,24 +33,59 @@ weight: version: --- -#### Swagger 2.0 +#### +###### 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. -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. +We've added support for OpenAPI 3.0 in Promitor v1.1 next to Swagger 2.0 along with +OpenAPI UI 3.0. -Templa hunc, exosa felix os temerasse Boreas facies nam ferre regimen! Fidemque -signans stant Volturnus dicta vides, utque caelo pallidiora. +**Impact:** <impact> -Tandem stat surgis. Rerum nati arbitrio, nactusque dilectos a! +**Alternative:** <alternative>. + +**Discussion:** [GitHub Issue #<issue-number>](https://github.com/tomkerkhove/promitor/issues/<issue-number>) ``` -## Deprecation Announcement +</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> From 4c0c26147ebe5272835975426cf37a0c6bdfd0a0 Mon Sep 17 00:00:00 2001 From: Tom Kerkhove <kerkhove.tom@gmail.com> Date: Tue, 26 Nov 2019 16:29:47 +0100 Subject: [PATCH 10/12] Align formatting --- changelog/content/released/v0.2.0.md | 10 +++++----- changelog/content/released/v0.2.1.md | 2 +- changelog/content/released/v0.3.0.md | 4 ++-- changelog/content/released/v0.4.0.md | 6 +++--- changelog/content/released/v0.4.1.md | 6 +++--- changelog/content/released/v0.5.0.md | 2 +- changelog/content/released/v0.6.0.md | 2 +- 7 files changed, 16 insertions(+), 16 deletions(-) diff --git a/changelog/content/released/v0.2.0.md b/changelog/content/released/v0.2.0.md index 7318b292f..daa4670e1 100644 --- a/changelog/content/released/v0.2.0.md +++ b/changelog/content/released/v0.2.0.md @@ -5,11 +5,11 @@ 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 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). \ No newline at end of file diff --git a/changelog/content/released/v0.2.1.md b/changelog/content/released/v0.2.1.md index b6aa4fcca..7467b74b0 100644 --- a/changelog/content/released/v0.2.1.md +++ b/changelog/content/released/v0.2.1.md @@ -5,6 +5,6 @@ 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))* +- {{% 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). \ No newline at end of file diff --git a/changelog/content/released/v0.3.0.md b/changelog/content/released/v0.3.0.md index 65b5aa66c..374e6120a 100644 --- a/changelog/content/released/v0.3.0.md +++ b/changelog/content/released/v0.3.0.md @@ -5,7 +5,7 @@ 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))* +- {{% 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). diff --git a/changelog/content/released/v0.4.0.md b/changelog/content/released/v0.4.0.md index 5ffbc3655..c303adeb6 100644 --- a/changelog/content/released/v0.4.0.md +++ b/changelog/content/released/v0.4.0.md @@ -5,8 +5,8 @@ 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))* +- {{% 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). diff --git a/changelog/content/released/v0.4.1.md b/changelog/content/released/v0.4.1.md index 077d7d299..13771b6a6 100644 --- a/changelog/content/released/v0.4.1.md +++ b/changelog/content/released/v0.4.1.md @@ -5,8 +5,8 @@ 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))* +- {{% 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). diff --git a/changelog/content/released/v0.5.0.md b/changelog/content/released/v0.5.0.md index 1d8788e34..a5c7778ad 100644 --- a/changelog/content/released/v0.5.0.md +++ b/changelog/content/released/v0.5.0.md @@ -5,6 +5,6 @@ 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))* +- {{% 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). diff --git a/changelog/content/released/v0.6.0.md b/changelog/content/released/v0.6.0.md index 4a0311b45..83d592c00 100644 --- a/changelog/content/released/v0.6.0.md +++ b/changelog/content/released/v0.6.0.md @@ -5,6 +5,6 @@ weight: 060 version: v0.6.0 --- -- {{% tag changed %}} Provide capability to opt-out of metric timestamps *([#290](https://github.com/tomkerkhove/promitor/issues/290))* +- {{% 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). From b8c922a40aa747bf16f517fc3d05da98860f13bc Mon Sep 17 00:00:00 2001 From: Tom Kerkhove <kerkhove.tom@gmail.com> Date: Tue, 26 Nov 2019 19:25:26 +0100 Subject: [PATCH 11/12] First batch of changes --- changelog/content/released/v1.0.0.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 changelog/content/released/v1.0.0.md diff --git a/changelog/content/released/v1.0.0.md b/changelog/content/released/v1.0.0.md new file mode 100644 index 000000000..f860947de --- /dev/null +++ b/changelog/content/released/v1.0.0.md @@ -0,0 +1,22 @@ +--- +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 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 added %}} End-to-end walkthrough how to deploy Promitor, Prometheus, and Grafana on an AKS Cluster ([walkthrough](https://promitor.io/walkthrough/)) + +https://promitor.io/configuration/v1.x/runtime#scraping-prometheus +Full release notes can be found [here](https://github.com/tomkerkhove/promitor/releases/tag/1.0.0). From 114083f69633a79f224b7c6e837f5d6e9b1fac58 Mon Sep 17 00:00:00 2001 From: Tom Kerkhove <kerkhove.tom@gmail.com> Date: Wed, 27 Nov 2019 17:23:20 +0100 Subject: [PATCH 12/12] Provide full v1.0.0 log --- changelog/content/released/v1.0.0.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/changelog/content/released/v1.0.0.md b/changelog/content/released/v1.0.0.md index f860947de..20b625335 100644 --- a/changelog/content/released/v1.0.0.md +++ b/changelog/content/released/v1.0.0.md @@ -14,9 +14,28 @@ version: v1.0.0 - {{% 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 added %}} End-to-end walkthrough how to deploy Promitor, Prometheus, and Grafana on an AKS Cluster ([walkthrough](https://promitor.io/walkthrough/)) +- {{% 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)) -https://promitor.io/configuration/v1.x/runtime#scraping-prometheus Full release notes can be found [here](https://github.com/tomkerkhove/promitor/releases/tag/1.0.0).