From fc949705346303d2d1fcd45d7aefd4e52b560ae2 Mon Sep 17 00:00:00 2001 From: Ben Harosh Date: Thu, 8 Aug 2024 10:55:37 -0700 Subject: [PATCH] PTRENG-6169 - Fix metrics documentation and helm values --- CHANGELOG.md | 6 +++++- README.md | 7 ++++++- helm/artifactory-ha-values.yaml | 3 ++- helm/artifactory-values.yaml | 3 ++- 4 files changed, 15 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 47ccda3..ed6aebd 100755 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,10 +2,14 @@ All changes to the log analytics integration will be documented in this file. +## [1.0.10] - August 8, 2024 + +* Fix metrics configuration due to deprication of `artifactory.openMetrics` as part of Artifactory 7.87.x charts and renaming it to `artifactory.metrics` + ## [1.0.9] - July 22, 2024 * FluentD sidecar version bumped to 4.5, to upgrade base image to bitnami/fluentd 1.17.0 -* Fixing metrics documentation +* Fixing metrics documentation ## [1.0.8] - June 7, 2024 diff --git a/README.md b/README.md index 5386a94..7f03eff 100644 --- a/README.md +++ b/README.md @@ -177,7 +177,9 @@ helm upgrade --install artifactory jfrog/artifactory \ -n $INST_NAMESPACE ``` -**If you are installing in the same cluster with the deprecated solution, Use the same namespace as the previous one instead of jfrog-plg above.** +**If you are installing in the same cluster with the deprecated solution, use the same namespace as the previous one instead of jfrog-plg above.** + +:bulb: Metrics collection is disabled by default in Artifactory. Please make sure that you are enabling them in Artifactory by setting `artifactory.metrics.enabled` to `true` in your [helm values file](helm/artifactory-values.yaml). For Artifactory versions <=7.86.x, please instead set the flag `artifactory.openMetrics.enabled` to `true` Artifactory-HA ⎈: @@ -194,6 +196,9 @@ helm upgrade --install artifactory-ha jfrog/artifactory-ha \ ``` **💡Note: If you are installing in the same cluster with the deprecated solution, Use the same namespace as the previous one instead of jfrog-plg above.** + +:bulb: Metrics collection is disabled by default in Artifactory-HA. Please make sure that you are enabling them in Artifactory by setting `artifactory.metrics.enabled` to `true` in your [helm values file](helm/artifactory-ha-values.yaml). For Artifactory versions <=7.86.x, please instead set the flag `artifactory.openMetrics.enabled` to `true` + Note the above examples are only references you will need additional parameters to configure TLS, binary blob storage, or other common Artifactory features. This will complete the necessary configuration for Artifactory and expose a new service monitor `servicemonitor-artifactory` to expose metrics to Prometheus. diff --git a/helm/artifactory-ha-values.yaml b/helm/artifactory-ha-values.yaml index fc42a77..87a1986 100644 --- a/helm/artifactory-ha-values.yaml +++ b/helm/artifactory-ha-values.yaml @@ -6,7 +6,8 @@ global: release_name: prometheus installerInfo: '{ "productId": "Helm_prometheus_artifactory/{{ .Chart.Version }}", "features": [ { "featureId": "ArtifactoryVersion/{{ default .Chart.AppVersion .Values.artifactory.image.version }}" }, { "featureId": "{{ if .Values.postgresql.enabled }}postgresql{{ else }}{{ .Values.database.type }}{{ end }}/0.0.0" }, { "featureId": "Platform/{{ default "kubernetes" .Values.installer.platform }}" }, { "featureId": "Channel/Helm_prometheus_artifactory" } ] }' artifactory: - openMetrics: + # For Artifactory versions <= 7.86.x please use artifactory.openMetrics.enabled instead of artifactory.metrics.enabled + metrics: enabled: true customInitContainersBegin: | - name: "prepare-fluentd-conf-on-persistent-volume" diff --git a/helm/artifactory-values.yaml b/helm/artifactory-values.yaml index f646f9e..e9f690f 100644 --- a/helm/artifactory-values.yaml +++ b/helm/artifactory-values.yaml @@ -6,7 +6,8 @@ global: release_name: prometheus installerInfo: '{ "productId": "Helm_prometheus_artifactory/{{ .Chart.Version }}", "features": [ { "featureId": "ArtifactoryVersion/{{ default .Chart.AppVersion .Values.artifactory.image.version }}" }, { "featureId": "{{ if .Values.postgresql.enabled }}postgresql{{ else }}{{ .Values.database.type }}{{ end }}/0.0.0" }, { "featureId": "Platform/{{ default "kubernetes" .Values.installer.platform }}" }, { "featureId": "Channel/Helm_prometheus_artifactory" } ] }' artifactory: - openMetrics: + # For Artifactory versions <= 7.86.x please use artifactory.openMetrics.enabled instead of artifactory.metrics.enabled + metrics: enabled: true customInitContainersBegin: | - name: "prepare-fluentd-conf-on-persistent-volume"