NetScaler ingress controller

Exporting metrics directly to Prometheus

May 16, 2024

Contributed by:

C C

NetScaler Ingress Controller now supports exporting metrics directly from NetScaler to Prometheus. With NetScaler Ingress Controller, you can automate the configurations required on NetScaler for exporting metrics directly.

Once you export the metrics, you can visualize the exported NetScaler metrics for easier interpretation and understanding using tools such as Grafana.

Configuring direct export of metrics from NetScaler CPX to Prometheus

To enable NetScaler Ingress Controller to configure NetScaler CPX to support direct export of metrics to Prometheus, you need to perform the following steps:

Create a Kubernetes secret to enable read-only access for a user. This step is required for NetScaler CPX to export metrics to Prometheus.

kubectl create secret generic prom-user --from-literal=username=<prometheus-username> --from-literal=password=<prometheus-password>
<!--NeedCopy-->

Deploy NetScaler CPX with NetScaler Ingress Controller using the following Helm commands:

helm repo add netscaler https://netscaler.github.io/netscaler-helm-charts/

helm install my-release netscaler/netscaler-cpx-with-ingress-controller --set license.accept=yes,nsic.prometheusCredentialSecret=<Secret-for-read-only-user-creation>,analyticsConfig.required=true,analyticsConfig.timeseries.metrics.enable=true,analyticsConfig.timeseries.port=5563,analyticsConfig.timeseries.metrics.mode=prometheus,analyticsConfig.timeseries.metrics.enableNativeScrape=true

<!--NeedCopy-->

The new parameters specified in the command are explained as follows:

nsic.prometheusCredentialSecret: Specifies the Kubernetes secret name for creating the read only user for native Prometheus support.
analyticsConfig.timeseries.metrics.enableNativeScrape: Set this value to true for directly exporting metrics to Prometheus

Add the appropriate Prometheus scrape job under scrape_configs in the Prometheus configuration depending on the Prometheus deployment.

If your Prometheus server is outside the Kubernetes cluster, add a scrape job under scrape_configs in the Prometheus configuration. For a sample Prometheus scrape job, see the Prometheus integration documentation.
If your Prometheus server is within the same Kubernetes cluster, add a new Prometheus job to configure Prometheus for directly exporting from a NetScaler CPX pod. For more information, see kubernetes_sd_config. A sample Prometheus job is given as follows:

- job_name: 'kubernetes-cpx'
  scheme: http
  metrics_path: /nitro/v1/config/systemfile
  params:
    args: ['filename:metrics_prom_ns_analytics_time_series_profile.log,filelocation:/var/nslog']
    format: ['prometheus']
  basic_auth:
    username:  # Prometheus username set in nsic.prometheusCredentialSecret
    password:  # Prometheus password set in nsic.prometheusCredentialSecret
  scrape_interval: 30s
  kubernetes_sd_configs:
  - role: pod
  relabel_configs:
  - source_labels: [__meta_kubernetes_pod_annotation_netscaler_prometheus_scrape]
    action: keep
    regex: true
  - source_labels: [__address__, __meta_kubernetes_pod_annotation_netscaler_prometheus_port]
    action: replace
    regex: ([^:]+)(?::\d+)?;(\d+)
    replacement: $1:$2
    target_label: __address__
  - source_labels: [__meta_kubernetes_namespace]
    action: replace
    target_label: kubernetes_namespace
  - source_labels: [__meta_kubernetes_pod_name]
    action: replace
    target_label: kubernetes_pod_name

<!--NeedCopy-->

Note:

For more information on Prometheus integration, see the NetScaler Prometheus integration documentation.

Configuring direct export of metrics from NetScaler VPX or NetScaler MPX to Prometheus

To enable NetScaler Ingress Controller to configure NetScaler VPX or NetScaler MPX to support direct export of metrics to Prometheus, you need to perform the following steps:

Deploy NetScaler Ingress Controller as a stand-alone pod using the Helm command:

    helm repo add netscaler https://netscaler.github.io/netscaler-helm-charts/

   helm install my-release netscaler/netscaler-ingress-controller --set nsIP=<NSIP>,license.accept=yes,adcCredentialSecret=<Secret-for-NetScaler-credentials>,analyticsConfig.required=true,analyticsConfig.timeseries.metrics.enable=true,analyticsConfig.timeseries.port=5563,analyticsConfig.timeseries.metrics.mode=prometheus,analyticsConfig.timeseries.metrics.enableNativeScrape=true
<!--NeedCopy-->

Create a system user with read only access for NetScaler VPX. For more details on the user creation, see the NetScaler Prometheus integration documentation.
Add a scrape job under scrape_configs in the prometheus configuration for enabling Prometheus to scrape from NetScaler VPX. For a sample Prometheus scrape job, see Prometheus configuration.

Note:

The scrape configuration section specifies a set of targets and configuration parameters describing how to scrape them. For more information on NetScaler specific parameters used in the configuration, see the NetScaler documentation.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Exporting metrics directly to Prometheus

May 16, 2024

Contributed by:

C C

May 16, 2024

Contributed by:

C C

Exporting metrics directly to Prometheus

Configuring direct export of metrics from NetScaler CPX to Prometheus

Configuring direct export of metrics from NetScaler VPX or NetScaler MPX to Prometheus

In this article