From 949fb4a48f516627aa214d48ec3daffe984bfba9 Mon Sep 17 00:00:00 2001 From: Tom Kerkhove Date: Mon, 2 Sep 2019 18:20:15 +0200 Subject: [PATCH] General Helm Chart improvements (#696) * Remove secret from file * Remove "runtime" prefix * Update sample * Use new metric format --- charts/promitor-agent-scraper/README.md | 18 +++++----- .../templates/NOTES.txt | 4 +-- .../templates/configmap.yaml | 26 +++++++------- charts/promitor-agent-scraper/values.yaml | 34 +++++++++---------- docs/deployment/index.md | 6 ---- docs/walkthrough/index.md | 5 +-- 6 files changed, 44 insertions(+), 49 deletions(-) diff --git a/charts/promitor-agent-scraper/README.md b/charts/promitor-agent-scraper/README.md index 5d05b2b00..b485cf7c8 100644 --- a/charts/promitor-agent-scraper/README.md +++ b/charts/promitor-agent-scraper/README.md @@ -52,15 +52,15 @@ The following table lists the configurable parameters of the Promitor chart and | `image.pullPolicy` | Policy to pull image | `Always` | | `azureAuthentication.appId` | Id of the Azure AD entity to authenticate with | | | `azureAuthentication.appKey` | Secret of the Azure AD entity to authenticate with | | -| `runtime.prometheus.scrapeEndpointPath` | Path where the scraping endpoint for Prometheus is being exposed | `/metrics` | -| `runtime.prometheus.enableMetricTimestamps` | Indication wheter or not to include timestamp | `true` | -| `runtime.prometheus.metricUnavailableValue` | Value to report in Prometheus when no metric was found wheter or not to include timestamp | `NaN` | -| `runtime.telemetry.applicationInsights.enabled` | Indication wheter or not to send telemetry to Azure Application Insights | `false` | -| `runtime.telemetry.applicationInsights.logLevel` | Minimum level of logging for Azure Application Insights | | -| `runtime.telemetry.applicationInsights.key` | Application Insights instrumentation key | | -| `runtime.telemetry.containerLogs.enabled` | Indication wheter or not to send telemetry to container logs | `true` | -| `runtime.telemetry.containerLogs.logLevel` | Minimum level of logging for container logs | | -| `runtime.telemetry.defaultLogLevel` | Minimum level of logging for all telemetry sinks, unless specified otherwise | `Error` | +| `prometheus.scrapeEndpointPath` | Path where the scraping endpoint for Prometheus is being exposed | `/metrics` | +| `prometheus.enableMetricTimestamps` | Indication wheter or not to include timestamp | `true` | +| `prometheus.metricUnavailableValue` | Value to report in Prometheus when no metric was found wheter or not to include timestamp | `NaN` | +| `telemetry.applicationInsights.enabled` | Indication wheter or not to send telemetry to Azure Application Insights | `false` | +| `telemetry.applicationInsights.logLevel` | Minimum level of logging for Azure Application Insights | | +| `telemetry.applicationInsights.key` | Application Insights instrumentation key | | +| `telemetry.containerLogs.enabled` | Indication wheter or not to send telemetry to container logs | `true` | +| `telemetry.containerLogs.logLevel` | Minimum level of logging for container logs | | +| `telemetry.defaultLogLevel` | Minimum level of logging for all telemetry sinks, unless specified otherwise | `Error` | | `azureMetadata.tenantId` | Id of Azure tenant | | | `azureMetadata.subscriptionId` | Id of Azure subscription | | | `azureMetadata.resourceGroupName` | Name of resource group | `promitor` | diff --git a/charts/promitor-agent-scraper/templates/NOTES.txt b/charts/promitor-agent-scraper/templates/NOTES.txt index 2daf9da18..43561e4b4 100644 --- a/charts/promitor-agent-scraper/templates/NOTES.txt +++ b/charts/promitor-agent-scraper/templates/NOTES.txt @@ -3,14 +3,14 @@ export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app={{ include "promitor-agent-scraper.name" . }},release={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") kubectl port-forward $POD_NAME 8080:{{ .Values.service.targetPort }} -2. Check the scraping output at http://127.0.0.1:8080{{ .Values.runtime.prometheus.scrapeEndpointPath }} +2. Check the scraping output at http://127.0.0.1:8080{{ .Values.prometheus.scrapeEndpointPath }} 3. To set up Prometheus in your cluster & pull in metrics from Promitor's scraping output, run: cat > promitor-scrape-config.yaml <" - # PROMITOR_AUTH_APPKEY (Required) - appKey: "" - azureMetadata: tenantId: "" subscriptionId: "" diff --git a/docs/walkthrough/index.md b/docs/walkthrough/index.md index 7a4242ebd..298e916b8 100755 --- a/docs/walkthrough/index.md +++ b/docs/walkthrough/index.md @@ -205,12 +205,13 @@ metrics: - name: demo_queue_size description: "Amount of active messages of the 'demo_queue' queue" resourceType: ServiceBusQueue - namespace: - queueName: demo_queue azureMetricConfiguration: metricName: ActiveMessages aggregation: type: Total + resources: + - namespace: + queueName: demo_queue ``` ## Deploy Promitor to your cluster using Helm