From 2309ef8f279595acdb0b38b29b7a28ab62336af7 Mon Sep 17 00:00:00 2001 From: Emmanuel Fortin Date: Fri, 1 Dec 2023 10:05:01 +0100 Subject: [PATCH] Add the proxyName args --- wavefront/README.md | 133 +++++++++++----------- wavefront/openshift/README.md | 131 ++++++++++----------- wavefront/templates/proxy-deployment.yaml | 1 + wavefront/values.yaml | 3 + 4 files changed, 137 insertions(+), 131 deletions(-) diff --git a/wavefront/README.md b/wavefront/README.md index 91a3444..b740b2f 100644 --- a/wavefront/README.md +++ b/wavefront/README.md @@ -54,72 +54,73 @@ You will need to provide values for those options for a successful installation The following tables lists the configurable parameters of the Wavefront chart and their default values. -| Parameter | Description | Default | -|---------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------| -| `clusterName` | Unique name for the Kubernetes cluster | `KUBERNETES_CLUSTER_NAME` | -| `wavefront.url` | Wavefront URL for your cluster | `https://YOUR_CLUSTER.wavefront.com` | -| `wavefront.token` | Wavefront API Token | `YOUR_API_TOKEN` | -| `collector.enabled` | Setup and enable the Wavefront collector to gather metrics | `true` | -| `collector.image.repository` | Wavefront collector image registry and name | `projects.registry.vmware.com/tanzu_observability/kubernetes-collector` | -| `collector.image.tag` | Wavefront collector image tag | `{TAG_NAME}` | -| `collector.image.pullPolicy` | Wavefront collector image pull policy | `IfNotPresent` | -| `collector.image.updateStrategy` | Wavefront collector updateStrategy | `nil` | -| `collector.useDaemonset` | Use Wavefront collector in Daemonset mode | `true` | -| `collector.maxProx` | Max number of CPU cores that can be used (< 1 for default) | `0` | -| `collector.logLevel` | Min logging level (info, debug, trace) | `info` | -| `collector.interval` | Default metrics collection interval | `60s` | -| `collector.flushInterval` | How often to force a metrics flush | `10s` | -| `collector.sinkDelay` | Timout for exporting data | `10s` | -| `collector.useReadOnlyPort` | Use un-authenticated port for kubelet | `false` | -| `collector.useProxy` | Use a Wavefront Proxy to send metrics through | `true` | -| `collector.proxyAddress` | Non-default Wavefront Proxy address to use, should only be set when `proxy.enabled` is false | `nil` | -| `collector.apiServerMetrics` | Collect metrics about Kubernetes API server | `false` | -| `collector.controlplane.enabled` | Enable control plane metrics [see more](https://github.com/wavefrontHQ/wavefront-collector-for-kubernetes/blob/main/docs/metrics.md#control-plane-metrics) | `true` | -| `collector.controlplane.collection.interval`| The collection interval for the control plane metrics | `120s` | -| `collector.kubernetesState` | Collect metrics about Kubernetes resource states [see more](https://github.com/wavefrontHQ/wavefront-collector-for-kubernetes/blob/main/docs/metrics.md#kubernetes-state-source) | `true` | -| `collector.cadvisor.enabled` | Enable cAdvisor prometheus endpoint. See the [cAdvisor docs](https://github.com/google/cadvisor/blob/main/docs/storage/prometheus.md) for details on what metrics are available. | `false` | -| `collector.filters` | Filters to apply towards all collected metrics | See values.yaml | -| `collector.tags` | Map of tags (key/value) to add to all metrics collected | `nil` | -| `collector.discovery.enabled` | Rules based and Prometheus endpoints auto-discovery | `true` | -| `collector.discovery.annotationPrefix` | Replaces `prometheus.io` as prefix for annotations of auto-discovered Prometheus endpoints | `prometheus.io` | -| `collector.discovery.enableRuntimeConfigs` | Enable runtime discovery rules [see more](https://github.com/wavefrontHQ/wavefront-collector-for-kubernetes/blob/main/docs/discovery.md#runtime-configurations) | `true` | -| `collector.discovery.annotationExcludes` | Exclude resources from annotation based auto-discovery [see more](https://github.com/wavefrontHQ/wavefront-collector-for-kubernetes/blob/main/docs/discovery.md) | `nil` | -| `collector.discovery.config` | Configuration for rules based auto-discovery [see more](https://github.com/wavefrontHQ/wavefront-collector-for-kubernetes/blob/main/docs/discovery.md) | `nil` | -| `collector.resources` | CPU/Memory resource requests/limits | CPU: `200m`/`200m`, Memory: `10Mi`/`256Mi` | -| `imagePullSecrets` | Enable Wavefront proxy and collector to pull from private image repositories. **Note:** secret must exist in namespace that will be used for the installation. | `nil` | -| `proxy.enabled` | Setup and enable Wavefront proxy to send metrics through | `true` | -| `proxy.image.repository` | Wavefront proxy image registry and name | `projects.registry.vmware.com/tanzu_observability/proxy` | -| `proxy.image.tag` | Wavefront proxy image tag | `{TAG_NAME}` | -| `proxy.image.pullPolicy` | Wavefront proxy image pull policy | `IfNotPresent` | -| `proxy.replicas` | Replicas to deploy for Wavefront proxy (usually 1) | `1` | -| `proxy.port` | Primary port for Wavefront data format metrics | `2878` | -| `proxy.httpProxyHost` | HTTP proxy host to be used in configurations when direct HTTP connections to Wavefront servers are not possible. Must be used with httpProxyPort. | `nil` | -| `proxy.httpProxyPort` | HTTP proxy port to be used in configurations when direct HTTP connections to Wavefront servers are not possible. Must be used with httpProxyHost. | `nil` | -| `proxy.useHttpProxyCAcert` | Enable HTTP proxy with CA cert. Must be used with httpProxyHost and httpProxyPort if set to true [see more](#ca-cert-configuration). | `false` | -| `proxy.httpProxyUser` | When used with httpProxyPassword, sets credentials to use with the HTTP proxy if the proxy requires authentication. | `nil` | -| `proxy.httpProxyPassword` | When used with httpProxyUser, sets credentials to use with the HTTP proxy if the proxy requires authentication. | `nil` | -| `proxy.tracePort` | Port for distributed tracing data (usually 30000) | `nil` | -| `proxy.jaegerPort` | Port for Jaeger format distributed tracing data (usually 30001) | `nil` | -| `proxy.traceJaegerHttpListenerPort` | Port for Jaeger Thrift format data (usually 30080) | `nil` | -| `proxy.traceJaegerGrpcListenerPort` | Port for Jaeger GRPC format data (usually 14250) | `nil` | -| `proxy.zipkinPort` | Port for Zipkin format distribued tracing data (usually 9411) | `nil` | -| `proxy.traceSamplingRate` | Distributed tracing data sampling rate (0 to 1) | `nil` | -| `proxy.traceSamplingDuration` | When set to greater than 0, spans that exceed this duration will force trace to be sampled (ms) | `nil` | -| `proxy.traceJaegerApplicationName` | Custom application name for traces received on Jaeger's traceJaegerListenerPorts or traceJaegerHttpListenerPorts. | `nil` | -| `proxy.traceZipkinApplicationName` | Custom application name for traces received on Zipkin's traceZipkinListenerPorts. | `nil` | -| `proxy.histogramPort` | Port for histogram distribution format data (usually 40000) | `nil` | -| `proxy.histogramMinutePort` | Port to accumulate 1-minute based histograms on Wavefront data format (usually 40001) | `nil` | -| `proxy.histogramHourPort` | Port to accumulate 1-hour based histograms on Wavefront data format (usually 40002) | `nil` | -| `proxy.histogramDayPort` | Port to accumulate 1-day based histograms on Wavefront data format (usually 40003) | `nil` | -| `proxy.deltaCounterPort` | Port to accumulate 1-minute delta counters on Wavefront data format (usually 50000) | `nil` | -| `proxy.args` | Additional Wavefront proxy properties to be passed as command line arguments in the `-- ` format. Multiple properties can be specified. [See more](https://docs.wavefront.com/proxies_configuring.html) | `nil` | -| `proxy.heap` | Wavefront proxy Java heap maximum usage (java -Xmx command line option) | `nil` | -| `proxy.preprocessor.rules.yaml` | YAML configuraiton for Wavefront proxy preprocessor rules. [See more](https://docs.wavefront.com/proxies_preprocessor_rules.html) | `nil` | -| `rbac.create` | Create RBAC resources | `true` | -| `serviceAccount.create` | Create Wavefront service account | `true` | -| `serviceAccount.name` | Name of Wavefront service account | `nil` | -| `kubeStateMetrics.enabled` | Setup and enable Kube State Metrics for collection | `false` | -| `vspheretanzu.enabled` | Enable and create role binding for vSphere with Tanzu kubernetes cluster | `false` | +| Parameter | Description | Default | +|----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------| +| `clusterName` | Unique name for the Kubernetes cluster | `KUBERNETES_CLUSTER_NAME` | +| `wavefront.url` | Wavefront URL for your cluster | `https://YOUR_CLUSTER.wavefront.com` | +| `wavefront.token` | Wavefront API Token | `YOUR_API_TOKEN` | +| `collector.enabled` | Setup and enable the Wavefront collector to gather metrics | `true` | +| `collector.image.repository` | Wavefront collector image registry and name | `projects.registry.vmware.com/tanzu_observability/kubernetes-collector` | +| `collector.image.tag` | Wavefront collector image tag | `{TAG_NAME}` | +| `collector.image.pullPolicy` | Wavefront collector image pull policy | `IfNotPresent` | +| `collector.image.updateStrategy` | Wavefront collector updateStrategy | `nil` | +| `collector.useDaemonset` | Use Wavefront collector in Daemonset mode | `true` | +| `collector.maxProx` | Max number of CPU cores that can be used (< 1 for default) | `0` | +| `collector.logLevel` | Min logging level (info, debug, trace) | `info` | +| `collector.interval` | Default metrics collection interval | `60s` | +| `collector.flushInterval` | How often to force a metrics flush | `10s` | +| `collector.sinkDelay` | Timout for exporting data | `10s` | +| `collector.useReadOnlyPort` | Use un-authenticated port for kubelet | `false` | +| `collector.useProxy` | Use a Wavefront Proxy to send metrics through | `true` | +| `collector.proxyAddress` | Non-default Wavefront Proxy address to use, should only be set when `proxy.enabled` is false | `nil` | +| `collector.apiServerMetrics` | Collect metrics about Kubernetes API server | `false` | +| `collector.controlplane.enabled` | Enable control plane metrics [see more](https://github.com/wavefrontHQ/wavefront-collector-for-kubernetes/blob/main/docs/metrics.md#control-plane-metrics) | `true` | +| `collector.controlplane.collection.interval` | The collection interval for the control plane metrics | `120s` | +| `collector.kubernetesState` | Collect metrics about Kubernetes resource states [see more](https://github.com/wavefrontHQ/wavefront-collector-for-kubernetes/blob/main/docs/metrics.md#kubernetes-state-source) | `true` | +| `collector.cadvisor.enabled` | Enable cAdvisor prometheus endpoint. See the [cAdvisor docs](https://github.com/google/cadvisor/blob/main/docs/storage/prometheus.md) for details on what metrics are available. | `false` | +| `collector.filters` | Filters to apply towards all collected metrics | See values.yaml | +| `collector.tags` | Map of tags (key/value) to add to all metrics collected | `nil` | +| `collector.discovery.enabled` | Rules based and Prometheus endpoints auto-discovery | `true` | +| `collector.discovery.annotationPrefix` | Replaces `prometheus.io` as prefix for annotations of auto-discovered Prometheus endpoints | `prometheus.io` | +| `collector.discovery.enableRuntimeConfigs` | Enable runtime discovery rules [see more](https://github.com/wavefrontHQ/wavefront-collector-for-kubernetes/blob/main/docs/discovery.md#runtime-configurations) | `true` | +| `collector.discovery.annotationExcludes` | Exclude resources from annotation based auto-discovery [see more](https://github.com/wavefrontHQ/wavefront-collector-for-kubernetes/blob/main/docs/discovery.md) | `nil` | +| `collector.discovery.config` | Configuration for rules based auto-discovery [see more](https://github.com/wavefrontHQ/wavefront-collector-for-kubernetes/blob/main/docs/discovery.md) | `nil` | +| `collector.resources` | CPU/Memory resource requests/limits | CPU: `200m`/`200m`, Memory: `10Mi`/`256Mi` | +| `imagePullSecrets` | Enable Wavefront proxy and collector to pull from private image repositories. **Note:** secret must exist in namespace that will be used for the installation. | `nil` | +| `proxy.enabled` | Setup and enable Wavefront proxy to send metrics through | `true` | +| `proxy.image.repository` | Wavefront proxy image registry and name | `projects.registry.vmware.com/tanzu_observability/proxy` | +| `proxy.image.tag` | Wavefront proxy image tag | `{TAG_NAME}` | +| `proxy.image.pullPolicy` | Wavefront proxy image pull policy | `IfNotPresent` | +| `proxy.replicas` | Replicas to deploy for Wavefront proxy (usually 1) | `1` | +| `proxy.port` | Primary port for Wavefront data format metrics | `2878` | +| `proxy.httpProxyHost` | HTTP proxy host to be used in configurations when direct HTTP connections to Wavefront servers are not possible. Must be used with httpProxyPort. | `nil` | +| `proxy.httpProxyPort` | HTTP proxy port to be used in configurations when direct HTTP connections to Wavefront servers are not possible. Must be used with httpProxyHost. | `nil` | +| `proxy.useHttpProxyCAcert` | Enable HTTP proxy with CA cert. Must be used with httpProxyHost and httpProxyPort if set to true [see more](#ca-cert-configuration). | `false` | +| `proxy.httpProxyUser` | When used with httpProxyPassword, sets credentials to use with the HTTP proxy if the proxy requires authentication. | `nil` | +| `proxy.httpProxyPassword` | When used with httpProxyUser, sets credentials to use with the HTTP proxy if the proxy requires authentication. | `nil` | +| `proxy.tracePort` | Port for distributed tracing data (usually 30000) | `nil` | +| `proxy.jaegerPort` | Port for Jaeger format distributed tracing data (usually 30001) | `nil` | +| `proxy.traceJaegerHttpListenerPort` | Port for Jaeger Thrift format data (usually 30080) | `nil` | +| `proxy.traceJaegerGrpcListenerPort` | Port for Jaeger GRPC format data (usually 14250) | `nil` | +| `proxy.zipkinPort` | Port for Zipkin format distribued tracing data (usually 9411) | `nil` | +| `proxy.traceSamplingRate` | Distributed tracing data sampling rate (0 to 1) | `nil` | +| `proxy.traceSamplingDuration` | When set to greater than 0, spans that exceed this duration will force trace to be sampled (ms) | `nil` | +| `proxy.traceJaegerApplicationName` | Custom application name for traces received on Jaeger's traceJaegerListenerPorts or traceJaegerHttpListenerPorts. | `nil` | +| `proxy.traceZipkinApplicationName` | Custom application name for traces received on Zipkin's traceZipkinListenerPorts. | `nil` | +| `proxy.histogramPort` | Port for histogram distribution format data (usually 40000) | `nil` | +| `proxy.histogramMinutePort` | Port to accumulate 1-minute based histograms on Wavefront data format (usually 40001) | `nil` | +| `proxy.histogramHourPort` | Port to accumulate 1-hour based histograms on Wavefront data format (usually 40002) | `nil` | +| `proxy.histogramDayPort` | Port to accumulate 1-day based histograms on Wavefront data format (usually 40003) | `nil` | +| `proxy.deltaCounterPort` | Port to accumulate 1-minute delta counters on Wavefront data format (usually 50000) | `nil` | +| `proxy.args` | Additional Wavefront proxy properties to be passed as command line arguments in the `-- ` format. Multiple properties can be specified. [See more](https://docs.wavefront.com/proxies_configuring.html) | `nil` | +| `proxy.heap` | Wavefront proxy Java heap maximum usage (java -Xmx command line option) | `nil` | +| `proxy.proxyName` | A name unique across your account representing the name of the proxy. The value is used for the source tag of the proxy metrics, such as JVM statistics, per-proxy point rates, and so on. | | +| `proxy.preprocessor.rules.yaml` | YAML configuraiton for Wavefront proxy preprocessor rules. [See more](https://docs.wavefront.com/proxies_preprocessor_rules.html) | `nil` | +| `rbac.create` | Create RBAC resources | `true` | +| `serviceAccount.create` | Create Wavefront service account | `true` | +| `serviceAccount.name` | Name of Wavefront service account | `nil` | +| `kubeStateMetrics.enabled` | Setup and enable Kube State Metrics for collection | `false` | +| `vspheretanzu.enabled` | Enable and create role binding for vSphere with Tanzu kubernetes cluster | `false` | ## Custom configuration diff --git a/wavefront/openshift/README.md b/wavefront/openshift/README.md index 619f024..0cdded3 100644 --- a/wavefront/openshift/README.md +++ b/wavefront/openshift/README.md @@ -45,71 +45,72 @@ You will need to provide values for those options for a successful installation The following tables lists the configurable parameters of the Wavefront chart and their default values. -| Parameter | Description | Default | -|---------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------| -| `clusterName` | Unique name for the OpenShift cluster | `KUBERNETES_CLUSTER_NAME` | -| `wavefront.url` | Wavefront URL for your cluster | `https://YOUR_CLUSTER.wavefront.com` | -| `wavefront.token` | Wavefront API Token | `YOUR_API_TOKEN` | -| `collector.enabled` | Setup and enable the Wavefront collector to gather metrics | `true` | -| `collector.image.repository` | Wavefront collector image registry and name | `registry.connect.redhat.com/wavefronthq/wavefront-kubernetes-collector` | -| `collector.image.tag` | Wavefront collector image tag | `{TAG_NAME}` | -| `collector.image.pullPolicy` | Wavefront collector image pull policy | `IfNotPresent` | -| `collector.image.updateStrategy` | Wavefront collector updateStrategy | `nil` | -| `collector.useDaemonset` | Use Wavefront collector in Daemonset mode | `true` | -| `collector.maxProx` | Max number of CPU cores that can be used (< 1 for default) | `0` | -| `collector.logLevel` | Min logging level (info, debug, trace) | `info` | -| `collector.interval` | Default metrics collection interval | `60s` | -| `collector.flushInterval` | How often to force a metrics flush | `10s` | -| `collector.sinkDelay` | Timout for exporting data | `10s` | -| `collector.useReadOnlyPort` | Use un-authenticated port for kubelet | `false` | -| `collector.useProxy` | Use a Wavefront Proxy to send metrics through | `true` | -| `collector.proxyAddress` | Non-default Wavefront Proxy address to use, should only be set when `proxy.enabled` is false | `nil` | -| `collector.apiServerMetrics` | Collect metrics about OpenShift API server | `false` | -| `collector.controlplane.enabled` | Enable control plane metrics [see more](https://github.com/wavefrontHQ/wavefront-collector-for-kubernetes/blob/main/docs/metrics.md#control-plane-metrics) | `true` | -| `collector.controlplane.collection.interval`| The collection interval for the control plane metrics | `120s` | -| `collector.kubernetesState` | Collect metrics about OpenShift resource states [see more](https://github.com/wavefrontHQ/wavefront-collector-for-kubernetes/blob/main/docs/metrics.md#kubernetes-state-source) | `true` | -| `collector.cadvisor.enabled` | Enable cAdvisor prometheus endpoint. See the [cAdvisor docs](https://github.com/google/cadvisor/blob/main/docs/storage/prometheus.md) for details on what metrics are available. | `false` | -| `collector.filters` | Filters to apply towards all collected metrics | See values.yaml | -| `collector.tags` | Map of tags (key/value) to add to all metrics collected | `nil` | -| `collector.discovery.enabled` | Rules based and Prometheus endpoints auto-discovery | `true` | -| `collector.discovery.annotationPrefix` | Replaces `prometheus.io` as prefix for annotations of auto-discovered Prometheus endpoints | `prometheus.io` | -| `collector.discovery.enableRuntimeConfigs` | Enable runtime discovery rules [see more](https://github.com/wavefrontHQ/wavefront-collector-for-kubernetes/blob/main/docs/discovery.md#runtime-configurations) | `true` | -| `collector.discovery.annotationExcludes` | Exclude resources from annotation based auto-discovery [see more](https://github.com/wavefrontHQ/wavefront-collector-for-kubernetes/blob/main/docs/discovery.md) | `nil` | -| `collector.discovery.config` | Configuration for rules based auto-discovery [see more](https://github.com/wavefrontHQ/wavefront-collector-for-kubernetes/blob/main/docs/discovery.md) | `nil` | -| `collector.resources` | CPU/Memory resource requests/limits | CPU: `200m`/`200m`, Memory: `10Mi`/`256Mi` | -| `imagePullSecrets` | Enable Wavefront proxy and collector to pull from private image repositories. **Note:** secret must exist in namespace that will be used for the installation. | `nil` | -| `proxy.enabled` | Setup and enable Wavefront proxy to send metrics through | `true` | -| `proxy.image.repository` | Wavefront proxy image registry and name | `registry.connect.redhat.com/wavefronthq/proxy` | -| `proxy.image.tag` | Wavefront proxy image tag | `{TAG_NAME}` | -| `proxy.image.pullPolicy` | Wavefront proxy image pull policy | `IfNotPresent` | -| `proxy.replicas` | Replicas to deploy for Wavefront proxy (usually 1) | `1` | -| `proxy.port` | Primary port for Wavefront data format metrics | `2878` | -| `proxy.httpProxyHost` | HTTP proxy host to be used in configurations when direct HTTP connections to Wavefront servers are not possible. Must be used with httpProxyPort. | `nil` | -| `proxy.httpProxyPort` | HTTP proxy port to be used in configurations when direct HTTP connections to Wavefront servers are not possible. Must be used with httpProxyHost. | `nil` | -| `proxy.useHttpProxyCAcert` | Enable HTTP proxy with CA cert. Must be used with httpProxyHost and httpProxyPort if set to true [see more](#ca-cert-configuration). | `false` | -| `proxy.httpProxyUser` | When used with httpProxyPassword, sets credentials to use with the HTTP proxy if the proxy requires authentication. | `nil` | -| `proxy.httpProxyPassword` | When used with httpProxyUser, sets credentials to use with the HTTP proxy if the proxy requires authentication. | `nil` | -| `proxy.tracePort` | Port for distributed tracing data (usually 30000) | `nil` | -| `proxy.jaegerPort` | Port for Jaeger format distributed tracing data (usually 30001) | `nil` | -| `proxy.traceJaegerHttpListenerPort` | Port for Jaeger Thrift format data (usually 30080) | `nil` | -| `proxy.traceJaegerGrpcListenerPort` | Port for Jaeger GRPC format data (usually 14250) | `nil` | -| `proxy.zipkinPort` | Port for Zipkin format distribued tracing data (usually 9411) | `nil` | -| `proxy.traceSamplingRate` | Distributed tracing data sampling rate (0 to 1) | `nil` | -| `proxy.traceSamplingDuration` | When set to greater than 0, spans that exceed this duration will force trace to be sampled (ms) | `nil` | -| `proxy.traceJaegerApplicationName` | Custom application name for traces received on Jaeger's traceJaegerListenerPorts or traceJaegerHttpListenerPorts. | `nil` | -| `proxy.traceZipkinApplicationName` | Custom application name for traces received on Zipkin's traceZipkinListenerPorts. | `nil` | -| `proxy.histogramPort` | Port for histogram distribution format data (usually 40000) | `nil` | -| `proxy.histogramMinutePort` | Port to accumulate 1-minute based histograms on Wavefront data format (usually 40001) | `nil` | -| `proxy.histogramHourPort` | Port to accumulate 1-hour based histograms on Wavefront data format (usually 40002) | `nil` | -| `proxy.histogramDayPort` | Port to accumulate 1-day based histograms on Wavefront data format (usually 40003) | `nil` | -| `proxy.deltaCounterPort` | Port to accumulate 1-minute delta counters on Wavefront data format (usually 50000) | `nil` | -| `proxy.args` | Additional Wavefront proxy properties to be passed as command line arguments in the `-- ` format. Multiple properties can be specified. [See more](https://docs.wavefront.com/proxies_configuring.html) | `nil` | -| `proxy.heap` | Wavefront proxy Java heap maximum usage (java -Xmx command line option) | `nil` | -| `proxy.preprocessor.rules.yaml` | YAML configuraiton for Wavefront proxy preprocessor rules. [See more](https://docs.wavefront.com/proxies_preprocessor_rules.html) | `nil` | -| `rbac.create` | Create RBAC resources | `true` | -| `serviceAccount.create` | Create Wavefront service account | `true` | -| `serviceAccount.name` | Name of Wavefront service account | `nil` | -| `kubeStateMetrics.enabled` | Setup and enable Kube State Metrics for collection | `false` | +| Parameter | Description | Default | +|----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------| +| `clusterName` | Unique name for the OpenShift cluster | `KUBERNETES_CLUSTER_NAME` | +| `wavefront.url` | Wavefront URL for your cluster | `https://YOUR_CLUSTER.wavefront.com` | +| `wavefront.token` | Wavefront API Token | `YOUR_API_TOKEN` | +| `collector.enabled` | Setup and enable the Wavefront collector to gather metrics | `true` | +| `collector.image.repository` | Wavefront collector image registry and name | `registry.connect.redhat.com/wavefronthq/wavefront-kubernetes-collector` | +| `collector.image.tag` | Wavefront collector image tag | `{TAG_NAME}` | +| `collector.image.pullPolicy` | Wavefront collector image pull policy | `IfNotPresent` | +| `collector.image.updateStrategy` | Wavefront collector updateStrategy | `nil` | +| `collector.useDaemonset` | Use Wavefront collector in Daemonset mode | `true` | +| `collector.maxProx` | Max number of CPU cores that can be used (< 1 for default) | `0` | +| `collector.logLevel` | Min logging level (info, debug, trace) | `info` | +| `collector.interval` | Default metrics collection interval | `60s` | +| `collector.flushInterval` | How often to force a metrics flush | `10s` | +| `collector.sinkDelay` | Timout for exporting data | `10s` | +| `collector.useReadOnlyPort` | Use un-authenticated port for kubelet | `false` | +| `collector.useProxy` | Use a Wavefront Proxy to send metrics through | `true` | +| `collector.proxyAddress` | Non-default Wavefront Proxy address to use, should only be set when `proxy.enabled` is false | `nil` | +| `collector.apiServerMetrics` | Collect metrics about OpenShift API server | `false` | +| `collector.controlplane.enabled` | Enable control plane metrics [see more](https://github.com/wavefrontHQ/wavefront-collector-for-kubernetes/blob/main/docs/metrics.md#control-plane-metrics) | `true` | +| `collector.controlplane.collection.interval` | The collection interval for the control plane metrics | `120s` | +| `collector.kubernetesState` | Collect metrics about OpenShift resource states [see more](https://github.com/wavefrontHQ/wavefront-collector-for-kubernetes/blob/main/docs/metrics.md#kubernetes-state-source) | `true` | +| `collector.cadvisor.enabled` | Enable cAdvisor prometheus endpoint. See the [cAdvisor docs](https://github.com/google/cadvisor/blob/main/docs/storage/prometheus.md) for details on what metrics are available. | `false` | +| `collector.filters` | Filters to apply towards all collected metrics | See values.yaml | +| `collector.tags` | Map of tags (key/value) to add to all metrics collected | `nil` | +| `collector.discovery.enabled` | Rules based and Prometheus endpoints auto-discovery | `true` | +| `collector.discovery.annotationPrefix` | Replaces `prometheus.io` as prefix for annotations of auto-discovered Prometheus endpoints | `prometheus.io` | +| `collector.discovery.enableRuntimeConfigs` | Enable runtime discovery rules [see more](https://github.com/wavefrontHQ/wavefront-collector-for-kubernetes/blob/main/docs/discovery.md#runtime-configurations) | `true` | +| `collector.discovery.annotationExcludes` | Exclude resources from annotation based auto-discovery [see more](https://github.com/wavefrontHQ/wavefront-collector-for-kubernetes/blob/main/docs/discovery.md) | `nil` | +| `collector.discovery.config` | Configuration for rules based auto-discovery [see more](https://github.com/wavefrontHQ/wavefront-collector-for-kubernetes/blob/main/docs/discovery.md) | `nil` | +| `collector.resources` | CPU/Memory resource requests/limits | CPU: `200m`/`200m`, Memory: `10Mi`/`256Mi` | +| `imagePullSecrets` | Enable Wavefront proxy and collector to pull from private image repositories. **Note:** secret must exist in namespace that will be used for the installation. | `nil` | +| `proxy.enabled` | Setup and enable Wavefront proxy to send metrics through | `true` | +| `proxy.image.repository` | Wavefront proxy image registry and name | `registry.connect.redhat.com/wavefronthq/proxy` | +| `proxy.image.tag` | Wavefront proxy image tag | `{TAG_NAME}` | +| `proxy.image.pullPolicy` | Wavefront proxy image pull policy | `IfNotPresent` | +| `proxy.replicas` | Replicas to deploy for Wavefront proxy (usually 1) | `1` | +| `proxy.port` | Primary port for Wavefront data format metrics | `2878` | +| `proxy.httpProxyHost` | HTTP proxy host to be used in configurations when direct HTTP connections to Wavefront servers are not possible. Must be used with httpProxyPort. | `nil` | +| `proxy.httpProxyPort` | HTTP proxy port to be used in configurations when direct HTTP connections to Wavefront servers are not possible. Must be used with httpProxyHost. | `nil` | +| `proxy.useHttpProxyCAcert` | Enable HTTP proxy with CA cert. Must be used with httpProxyHost and httpProxyPort if set to true [see more](#ca-cert-configuration). | `false` | +| `proxy.httpProxyUser` | When used with httpProxyPassword, sets credentials to use with the HTTP proxy if the proxy requires authentication. | `nil` | +| `proxy.proxyName` | A name unique across your account representing the name of the proxy. The value is used for the source tag of the proxy metrics, such as JVM statistics, per-proxy point rates, and so on. | | +| `proxy.httpProxyPassword` | When used with httpProxyUser, sets credentials to use with the HTTP proxy if the proxy requires authentication. | `nil` | +| `proxy.tracePort` | Port for distributed tracing data (usually 30000) | `nil` | +| `proxy.jaegerPort` | Port for Jaeger format distributed tracing data (usually 30001) | `nil` | +| `proxy.traceJaegerHttpListenerPort` | Port for Jaeger Thrift format data (usually 30080) | `nil` | +| `proxy.traceJaegerGrpcListenerPort` | Port for Jaeger GRPC format data (usually 14250) | `nil` | +| `proxy.zipkinPort` | Port for Zipkin format distribued tracing data (usually 9411) | `nil` | +| `proxy.traceSamplingRate` | Distributed tracing data sampling rate (0 to 1) | `nil` | +| `proxy.traceSamplingDuration` | When set to greater than 0, spans that exceed this duration will force trace to be sampled (ms) | `nil` | +| `proxy.traceJaegerApplicationName` | Custom application name for traces received on Jaeger's traceJaegerListenerPorts or traceJaegerHttpListenerPorts. | `nil` | +| `proxy.traceZipkinApplicationName` | Custom application name for traces received on Zipkin's traceZipkinListenerPorts. | `nil` | +| `proxy.histogramPort` | Port for histogram distribution format data (usually 40000) | `nil` | +| `proxy.histogramMinutePort` | Port to accumulate 1-minute based histograms on Wavefront data format (usually 40001) | `nil` | +| `proxy.histogramHourPort` | Port to accumulate 1-hour based histograms on Wavefront data format (usually 40002) | `nil` | +| `proxy.histogramDayPort` | Port to accumulate 1-day based histograms on Wavefront data format (usually 40003) | `nil` | +| `proxy.deltaCounterPort` | Port to accumulate 1-minute delta counters on Wavefront data format (usually 50000) | `nil` | +| `proxy.args` | Additional Wavefront proxy properties to be passed as command line arguments in the `-- ` format. Multiple properties can be specified. [See more](https://docs.wavefront.com/proxies_configuring.html) | `nil` | +| `proxy.heap` | Wavefront proxy Java heap maximum usage (java -Xmx command line option) | `nil` | +| `proxy.preprocessor.rules.yaml` | YAML configuraiton for Wavefront proxy preprocessor rules. [See more](https://docs.wavefront.com/proxies_preprocessor_rules.html) | `nil` | +| `rbac.create` | Create RBAC resources | `true` | +| `serviceAccount.create` | Create Wavefront service account | `true` | +| `serviceAccount.name` | Name of Wavefront service account | `nil` | +| `kubeStateMetrics.enabled` | Setup and enable Kube State Metrics for collection | `false` | ## Custom configuration diff --git a/wavefront/templates/proxy-deployment.yaml b/wavefront/templates/proxy-deployment.yaml index 9b1bf0d..c3c0219 100644 --- a/wavefront/templates/proxy-deployment.yaml +++ b/wavefront/templates/proxy-deployment.yaml @@ -57,6 +57,7 @@ spec: {{- if .Values.proxy.httpProxyPort }} --proxyPort {{ .Values.proxy.httpProxyPort }}{{- end -}} {{- if .Values.proxy.httpProxyUser }} --proxyUser {{ .Values.proxy.httpProxyUser }}{{- end -}} {{- if .Values.proxy.httpProxyPassword }} --proxyPassword {{ .Values.proxy.httpProxyPassword }}{{- end -}} + {{- if .Values.proxy.proxyName }} --proxyName {{ .Values.proxy.proxyName }}{{- end -}} {{- if .Values.proxy.heap }} - name: JAVA_HEAP_USAGE value: {{ .Values.proxy.heap | quote }} diff --git a/wavefront/values.yaml b/wavefront/values.yaml index 53640c7..bea32fe 100644 --- a/wavefront/values.yaml +++ b/wavefront/values.yaml @@ -307,6 +307,9 @@ proxy: ## Custom application name for traces received on Jaeger's traceJaegerListenerPorts or traceJaegerHttpListenerPorts. # traceJaegerApplicationName: MyJaegerDemo + ## A name unique across your account representing the name of the proxy. The value is used for the source tag of the proxy metrics, such as JVM statistics, per-proxy point rates, and so on. | | + # proxyName: "My source name" + ## Custom application name for traces received on Zipkin's traceZipkinListenerPorts. # traceZipkinApplicationName: MyZipkinDemo