emqx-exporter

Chainguard Container for emqx-exporter

The emqx-exporter is designed to expose partial metrics that are not included in the EMQX Prometheus API.

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/emqx-exporter:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Compatibility Notes

This image is based on the upstream emqx-exporter image, with the following differences:

• Like all other Chainguard Containers, emqx-exporter features a stripped down, minimal design container image
• It has few-to-zero CVEs

Getting Started

EMQX Exporter can be deployed either as a standalone container or inside a Kubernetes cluster. This section provides minimal examples to help you start the service using the supported deployment methods.

Running with Docker

git clone https://github.com/emqx/emqx-exporter
cd emqx-exporter/examples/docker-compose

# Replace the emqx-exporter image with the Wolfi variant:
IMAGE="cgr.dev/ORGANIZATION/emqx-exporter:latest" yq -i '.services."emqx-exporter".image = env(IMAGE)' docker-compose.yml

# Start the deployment
docker-compose up -d

You should now see the exported metrics in prometheus&grafana. You can also query them via promtool:

# Check the exposed metrics
curl http://localhost:8085/metrics
# Query the metrics
promtool query instant http://localhost:9090 emqx_cluster_status

Running with Kubernetes

git clone https://github.com/emqx/emqx-exporter
cd emqx-exporter

# Replace the emqx-exporter image with the Wolfi variant:
IMAGE="cgr.dev/ORGANIZATION/emqx-exporter:latest"  yq -i '
(. | select(.kind == "Deployment" and .metadata.name == "emqx-exporter")
    | .spec.template.spec.containers[]
    | select(.name == "exporter")
    | .image) = env(IMAGE)
' examples/kubernetes/resources/emqx-exporter.yaml

# Install EMQX-Operator
helm repo add jetstack https://charts.jetstack.io
helm repo update
helm upgrade --install cert-manager jetstack/cert-manager \
  --namespace cert-manager \
  --create-namespace \
  --set crds.enabled=true
helm repo add emqx https://repos.emqx.io/charts
helm repo update
helm upgrade --install emqx-operator emqx/emqx-operator \
  --namespace emqx-operator-system \
  --create-namespace
kubectl wait --for=condition=Ready pods -l "control-plane=controller-manager" -n emqx-operator-system

# Install CRDs for prometheus stack
git clone https://github.com/prometheus-operator/kube-prometheus.git
cd kube-prometheus
kubectl apply --server-side -f manifests/setup
kubectl wait \
	--for condition=Established \
	--all CustomResourceDefinition \
	--namespace=monitoring

# Install EMQX & EMQX Exporter
cd ..
kubectl apply -k examples/kubernetes --server-side

You should now see the exported metrics in prometheus&grafana. You can also query them via promtool:

# Expose the emqx-exporter service 
kubectl port-forward svc/emqx-exporter-service 8085:8085

# Check the exposed metrics
curl http://localhost:8085/metrics

# Expose the prometheus service
kubectl -n monitoring port-forward svc/prometheus-k8s 9090:9090

# Query the metrics
promtool query instant http://localhost:9090 emqx_cluster_status

Documentation and Resources

For more information about Emqx-Exporter in container images, please refer to the emqx website or to the official repository.

What are Chainguard Containers?

Chainguard's free tier of Starter container images are built with Wolfi, our minimal Linux undistro.

All other Chainguard Containers are built with Chainguard OS, Chainguard's minimal Linux operating system designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a development, or -dev, variant.

In all other cases, including Chainguard Containers tagged as :latest or with a specific version number, the container images include only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager.

Although the -dev container image variants have similar security features as their more minimal versions, they include additional software that is typically not necessary in production environments. We recommend using multi-stage builds to copy artifacts from the -dev variant into a more minimal production image.

Need additional packages?

To improve security, Chainguard Containers include only essential dependencies. Need more packages? Chainguard customers can use Custom Assembly to add packages, either through the Console, chainctl, or API.

To use Custom Assembly in the Chainguard Console: navigate to the image you'd like to customize in your Organization's list of images, and click on the Customize image button at the top of the page.

Learn More

Refer to our Chainguard Containers documentation on Chainguard Academy. Chainguard also offers VMs and Libraries — contact us for access.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.