Elastic-Metricbeat

There are various customizations you can do to tailor the deployment of OpenStack Elastic-Metricbeat. You can find those below.

General Parameters

• conf.metricbeat.metricbeat.config.modules.path

  • Type: string

  • Description:

  • “${path.config}/modules.d/*.yml”

• conf.metricbeat.metricbeat.config.modules.reload.enabled

  • Type: bool

  • Description:

  • true

• conf.metricbeat.output.elasticsearch.hosts[0]

  • Type: string

  • Description:

  • “${ELASTICSEARCH_HOST}:${ELASTICSEARCH_PORT}”

• conf.metricbeat.output.elasticsearch.password

  • Type: string

  • Description:

  • “${ELASTICSEARCH_PASSWORD}”

• conf.metricbeat.output.elasticsearch.username

  • Type: string

  • Description:

  • “${ELASTICSEARCH_USERNAME}”

• conf.metricbeat.setup.dashboards.enabled

  • Type: bool

  • Description:

  • true

• conf.metricbeat.setup.dashboards.index

  • Type: string

  • Description:

  • “metricbeat-*”

• conf.metricbeat.setup.dashboards.retry.enabled

  • Type: bool

  • Description:

  • true

• conf.metricbeat.setup.dashboards.retry.interval

  • Type: int

  • Description:

  • 5

• conf.metricbeat.setup.kibana.host

  • Type: string

  • Description:

  • “${KIBANA_HOST}:${KIBANA_PORT}”

• conf.metricbeat.setup.kibana.password

  • Type: string

  • Description:

  • “${ELASTICSEARCH_PASSWORD}”

• conf.metricbeat.setup.kibana.username

  • Type: string

  • Description:

  • “${ELASTICSEARCH_USERNAME}”

• conf.modules.daemonset_kubernetes[0].add_metadata

  • Type: bool

  • Description:

  • true

• conf.modules.daemonset_kubernetes[0].enabled

  • Type: bool

  • Description:

  • true

• conf.modules.daemonset_kubernetes[0].hosts[0]

  • Type: string

  • Description:

  • “localhost:10255”

• conf.modules.daemonset_kubernetes[0].in_cluster

  • Type: bool

  • Description:

  • true

• conf.modules.daemonset_kubernetes[0].metricsets[0]

  • Type: string

  • Description:

  • “node”

• conf.modules.daemonset_kubernetes[0].metricsets[1]

  • Type: string

  • Description:

  • “system”

• conf.modules.daemonset_kubernetes[0].metricsets[2]

  • Type: string

  • Description:

  • “pod”

• conf.modules.daemonset_kubernetes[0].metricsets[3]

  • Type: string

  • Description:

  • “container”

• conf.modules.daemonset_kubernetes[0].metricsets[4]

  • Type: string

  • Description:

  • “volume”

• conf.modules.daemonset_kubernetes[0].module

  • Type: string

  • Description:

  • “kubernetes”

• conf.modules.daemonset_kubernetes[0].period

  • Type: string

  • Description:

  • “10s”

• conf.modules.deployment_kubernetes[0].add_metadata

  • Type: bool

  • Description:

  • true

• conf.modules.deployment_kubernetes[0].enabled

  • Type: bool

  • Description:

  • true

• conf.modules.deployment_kubernetes[0].hosts[0]

  • Type: string

  • Description:

  • “${KUBE_STATE_METRICS_HOST}:${KUBE_STATE_METRICS_PORT}”

• conf.modules.deployment_kubernetes[0].in_cluster

  • Type: bool

  • Description:

  • true

• conf.modules.deployment_kubernetes[0].metricsets[0]

  • Type: string

  • Description:

  • “state_node”

• conf.modules.deployment_kubernetes[0].metricsets[1]

  • Type: string

  • Description:

  • “state_deployment”

• conf.modules.deployment_kubernetes[0].metricsets[2]

  • Type: string

  • Description:

  • “state_replicaset”

• conf.modules.deployment_kubernetes[0].metricsets[3]

  • Type: string

  • Description:

  • “state_pod”

• conf.modules.deployment_kubernetes[0].metricsets[4]

  • Type: string

  • Description:

  • “state_container”

• conf.modules.deployment_kubernetes[0].metricsets[5]

  • Type: string

  • Description:

  • “event”

• conf.modules.deployment_kubernetes[0].module

  • Type: string

  • Description:

  • “kubernetes”

• conf.modules.deployment_kubernetes[0].period

  • Type: string

  • Description:

  • “10s”

• conf.modules.docker[0].enabled

  • Type: bool

  • Description:

  • true

• conf.modules.docker[0].hosts[0]

  • Type: string

  • Description:

  • “unix:///var/run/docker.sock”

• conf.modules.docker[0].metricsets[0]

  • Type: string

  • Description:

  • “container”

• conf.modules.docker[0].metricsets[1]

  • Type: string

  • Description:

  • “cpu”

• conf.modules.docker[0].metricsets[2]

  • Type: string

  • Description:

  • “diskio”

• conf.modules.docker[0].metricsets[3]

  • Type: string

  • Description:

  • “healthcheck”

• conf.modules.docker[0].metricsets[4]

  • Type: string

  • Description:

  • “info”

• conf.modules.docker[0].metricsets[5]

  • Type: string

  • Description:

  • “image”

• conf.modules.docker[0].metricsets[6]

  • Type: string

  • Description:

  • “memory”

• conf.modules.docker[0].metricsets[7]

  • Type: string

  • Description:

  • “network”

• conf.modules.docker[0].module

  • Type: string

  • Description:

  • “docker”

• conf.modules.docker[0].period

  • Type: string

  • Description:

  • “10s”

• conf.modules.system[0].”core.metrics”[0]

  • Type: string

  • Description:

  • “percentages”

• conf.modules.system[0].”cpu.metrics”[0]

  • Type: string

  • Description:

  • “percentages”

• conf.modules.system[0].”process.include_top_n”.by_cpu

  • Type: int

  • Description:

  • 5

• conf.modules.system[0].”process.include_top_n”.by_memory

  • Type: int

  • Description:

  • 5

• conf.modules.system[0].enabled

  • Type: bool

  • Description:

  • true

• conf.modules.system[0].metricsets[0]

  • Type: string

  • Description:

  • “cpu”

• conf.modules.system[0].metricsets[10]

  • Type: string

  • Description:

  • “fsstat”

• conf.modules.system[0].metricsets[1]

  • Type: string

  • Description:

  • “load”

• conf.modules.system[0].metricsets[2]

  • Type: string

  • Description:

  • “memory”

• conf.modules.system[0].metricsets[3]

  • Type: string

  • Description:

  • “network”

• conf.modules.system[0].metricsets[4]

  • Type: string

  • Description:

  • “process”

• conf.modules.system[0].metricsets[5]

  • Type: string

  • Description:

  • “process_summary”

• conf.modules.system[0].metricsets[6]

  • Type: string

  • Description:

  • “core”

• conf.modules.system[0].metricsets[7]

  • Type: string

  • Description:

  • “diskio”

• conf.modules.system[0].metricsets[8]

  • Type: string

  • Description:

  • “socket”

• conf.modules.system[0].metricsets[9]

  • Type: string

  • Description:

  • “filesystem”

• conf.modules.system[0].module

  • Type: string

  • Description:

  • “system”

• conf.modules.system[0].period

  • Type: string

  • Description:

  • “10s”

• conf.modules.system[0].processes[0]

  • Type: string

  • Description:

  • “.*”

• dependencies.dynamic.common.local_image_registry.jobs[0]

  • Type: string

  • Description:

  • “metricbeat-image-repo-sync”

• dependencies.dynamic.common.local_image_registry.services[0].endpoint

  • Type: string

  • Description:

  • “node”

• dependencies.dynamic.common.local_image_registry.services[0].service

  • Type: string

  • Description:

  • “local_image_registry”

• dependencies.static.image_repo_sync.services[0].endpoint

  • Type: string

  • Description:

  • “internal”

• dependencies.static.image_repo_sync.services[0].service

  • Type: string

  • Description:

  • “local_image_registry”

• dependencies.static.metricbeat.services[0].endpoint

  • Type: string

  • Description:

  • “internal”

• dependencies.static.metricbeat.services[0].service

  • Type: string

  • Description:

  • “kibana”

• endpoints.cluster_domain_suffix

  • Type: string

  • Description:

  • “cluster.local”

• endpoints.elasticsearch.auth.admin.password

  • Type: string

  • Description:

  • “changeme”

• endpoints.elasticsearch.auth.admin.username

  • Type: string

  • Description:

  • “admin”

• endpoints.elasticsearch.host_fqdn_override.default

  • Type: string

  • Description:

  • nil

• endpoints.elasticsearch.hosts.data

  • Type: string

  • Description:

  • “elasticsearch-data”

• endpoints.elasticsearch.hosts.default

  • Type: string

  • Description:

  • “elasticsearch-logging”

• endpoints.elasticsearch.hosts.discovery

  • Type: string

  • Description:

  • “elasticsearch-discovery”

• endpoints.elasticsearch.hosts.public

  • Type: string

  • Description:

  • “elasticsearch”

• endpoints.elasticsearch.name

  • Type: string

  • Description:

  • “elasticsearch”

• endpoints.elasticsearch.namespace

  • Type: string

  • Description:

  • nil

• endpoints.elasticsearch.path.default

  • Type: string

  • Description:

  • nil

• endpoints.elasticsearch.port.http.default

  • Type: int

  • Description:

  • 80

• endpoints.elasticsearch.scheme.default

  • Type: string

  • Description:

  • “http”

• endpoints.kibana.host_fqdn_override.default

  • Type: string

  • Description:

  • nil

• endpoints.kibana.hosts.default

  • Type: string

  • Description:

  • “kibana-dash”

• endpoints.kibana.hosts.public

  • Type: string

  • Description:

  • “kibana”

• endpoints.kibana.name

  • Type: string

  • Description:

  • “kibana”

• endpoints.kibana.namespace

  • Type: string

  • Description:

  • “osh-infra”

• endpoints.kibana.path.default

  • Type: string

  • Description:

  • nil

• endpoints.kibana.port.http.default

  • Type: int

  • Description:

  • 80

• endpoints.kibana.port.kibana.default

  • Type: int

  • Description:

  • 5601

• endpoints.kibana.scheme.default

  • Type: string

  • Description:

  • “http”

• endpoints.kube_state_metrics.host_fqdn_override.default

  • Type: string

  • Description:

  • nil

• endpoints.kube_state_metrics.hosts.default

  • Type: string

  • Description:

  • “kube-state-metrics”

• endpoints.kube_state_metrics.namespace

  • Type: string

  • Description:

  • nil

• endpoints.kube_state_metrics.path.default

  • Type: string

  • Description:

  • nil

• endpoints.kube_state_metrics.port.metrics.default

  • Type: int

  • Description:

  • 8080

• endpoints.kube_state_metrics.scheme.default

  • Type: string

  • Description:

  • “http”

• endpoints.local_image_registry.host_fqdn_override.default

  • Type: string

  • Description:

  • nil

• endpoints.local_image_registry.hosts.default

  • Type: string

  • Description:

  • “localhost”

• endpoints.local_image_registry.hosts.internal

  • Type: string

  • Description:

  • “docker-registry”

• endpoints.local_image_registry.hosts.node

  • Type: string

  • Description:

  • “localhost”

• endpoints.local_image_registry.name

  • Type: string

  • Description:

  • “docker-registry”

• endpoints.local_image_registry.namespace

  • Type: string

  • Description:

  • “docker-registry”

• endpoints.local_image_registry.port.registry.node

  • Type: int

  • Description:

  • 5000

• endpoints.oci_image_registry.auth.elastic-metricbeat.password

  • Type: string

  • Description:

  • “password”

• endpoints.oci_image_registry.auth.elastic-metricbeat.username

  • Type: string

  • Description:

  • “elastic-metricbeat”

• endpoints.oci_image_registry.auth.enabled

  • Type: bool

  • Description:

  • false

• endpoints.oci_image_registry.host_fqdn_override.default

  • Type: string

  • Description:

  • nil

• endpoints.oci_image_registry.hosts.default

  • Type: string

  • Description:

  • “localhost”

• endpoints.oci_image_registry.name

  • Type: string

  • Description:

  • “oci-image-registry”

• endpoints.oci_image_registry.namespace

  • Type: string

  • Description:

  • “oci-image-registry”

• endpoints.oci_image_registry.port.registry.default

  • Type: string

  • Description:

  • nil

• images.local_registry.active

  • Type: bool

  • Description:

  • false

• images.local_registry.exclude[0]

  • Type: string

  • Description:

  • “dep_check”

• images.local_registry.exclude[1]

  • Type: string

  • Description:

  • “image_repo_sync”

• images.pull_policy

  • Type: string

  • Description:

  • “IfNotPresent”

• images.tags.dep_check

  • Type: string

  • Description:

  • “quay.io/airshipit/kubernetes-entrypoint:latest-ubuntu_focal”

• images.tags.image_repo_sync

  • Type: string

  • Description:

  • “docker.io/library/docker:17.07.0”

• images.tags.metricbeat

  • Type: string

  • Description:

  • “docker.elastic.co/beats/metricbeat-oss:7.1.0”

• labels.job.node_selector_key

  • Type: string

  • Description:

  • “openstack-control-plane”

• labels.job.node_selector_value

  • Type: string

  • Description:

  • “enabled”

• labels.metricbeat.node_selector_key

  • Type: string

  • Description:

  • “openstack-control-plane”

• labels.metricbeat.node_selector_value

  • Type: string

  • Description:

  • “enabled”

• manifests.configmap_bin

  • Type: bool

  • Description:

  • true

• manifests.configmap_etc

  • Type: bool

  • Description:

  • true

• manifests.daemonset

  • Type: bool

  • Description:

  • true

• manifests.deployment

  • Type: bool

  • Description:

  • true

• manifests.job_image_repo_sync

  • Type: bool

  • Description:

  • true

• manifests.secret_elasticsearch

  • Type: bool

  • Description:

  • true

• manifests.secret_registry

  • Type: bool

  • Description:

  • true

• pod.affinity.anti.topologyKey.default

  • Type: string

  • Description:

  • “kubernetes.io/hostname”

• pod.affinity.anti.type.default

  • Type: string

  • Description:

  • “preferredDuringSchedulingIgnoredDuringExecution”

• pod.affinity.anti.weight.default

  • Type: int

  • Description:

  • 10

• pod.dns_policy

  • Type: string

  • Description:

  • “ClusterFirstWithHostNet”

• pod.lifecycle.upgrades.daemonsets.metricbeat.enabled

  • Type: bool

  • Description:

  • true

• pod.lifecycle.upgrades.daemonsets.metricbeat.max_unavailable

  • Type: int

  • Description:

  • 1

• pod.lifecycle.upgrades.daemonsets.metricbeat.min_ready_seconds

  • Type: int

  • Description:

  • 0

• pod.lifecycle.upgrades.daemonsets.pod_replacement_strategy

  • Type: string

  • Description:

  • “RollingUpdate”

• pod.mounts.metricbeat.metricbeat

  • Type: string

  • Description:

  • nil

• pod.replicas.metricbeat

  • Type: int

  • Description:

  • 1

• pod.resources.metricbeat.enabled

  • Type: bool

  • Description:

  • false

• pod.resources.metricbeat.limits.cpu

  • Type: string

  • Description:

  • “400m”

• pod.resources.metricbeat.limits.memory

  • Type: string

  • Description:

  • “400Mi”

• pod.resources.metricbeat.requests.cpu

  • Type: string

  • Description:

  • “100m”

• pod.resources.metricbeat.requests.memory

  • Type: string

  • Description:

  • “100Mi”

• pod.tolerations.metricbeat.enabled

  • Type: bool

  • Description:

  • false

• pod.tolerations.metricbeat.tolerations[0].key

  • Type: string

  • Description:

  • “node-role.kubernetes.io/master”

• pod.tolerations.metricbeat.tolerations[0].operator

  • Type: string

  • Description:

  • “Exists”

• pod.tolerations.metricbeat.tolerations[1].key

  • Type: string

  • Description:

  • “node-role.kubernetes.io/control-plane”

• pod.tolerations.metricbeat.tolerations[1].operator

  • Type: string

  • Description:

  • “Exists”

• pod.tolerations.metricbeat.tolerations[2].key

  • Type: string

  • Description:

  • “node-role.kubernetes.io/node”

• pod.tolerations.metricbeat.tolerations[2].operator

  • Type: string

  • Description:

  • “Exists”

• release_group

  • Type: string

  • Description:

  • nil

• secrets.elasticsearch.user

  • Type: string

  • Description:

  • “metricbeat-elasticsearch-user”

• secrets.oci_image_registry.elastic-metricbeat

  • Type: string

  • Description:

  • “elastic-metricbeat-oci-image-registry-key”