Skip to content

Commit 0c902bb

Browse files
authored
Adding information for NETINFO environmental variable (#463)
* Adding information for NETINFO environmental variable * Changing variable to ELASTIC_NETINFO * Set default ELASTIC_NETINFO:false
1 parent 3a535c4 commit 0c902bb

File tree

3 files changed

+33
-2
lines changed

3 files changed

+33
-2
lines changed

docs/en/ingest-management/elastic-agent/configuration/env/container-envs.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,9 @@ include::shared-env.asciidoc[tag=kibana-password]
4848

4949
include::shared-env.asciidoc[tag=kibana-ca]
5050

51+
include::shared-env.asciidoc[tag=elastic-netinfo]
52+
53+
5154
|===
5255

5356
[discrete]

docs/en/ingest-management/elastic-agent/configuration/env/shared-env.asciidoc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -560,4 +560,20 @@ contains your CA's certificate.
560560

561561
// end::kibana-ca[]
562562

563+
// tag::elastic-netinfo[]
564+
|
565+
[id="env-{type}-elastic-netinfo"]
566+
`ELASTIC_NETINFO`
567+
568+
| (bool) When `false`, disables `netinfo.enabled` parameter of `add_host_metadata` processor.
569+
Setting this to `false` is recommended for large scale setups where the host.ip and host.mac fields index size increases.
570+
571+
By default, {agent} initializes the `add_host_metadata` processor. The `netinfo.enabled` parameter defines ingestion of IP addresses and MAC addresses as fields `host.ip` and `host.mac`.
572+
For more information see <<add_host_metadata-processor>>
573+
574+
575+
*Default:* `"false"`
576+
577+
// end::elastic-netinfo[]
578+
563579
// =============================================================================

docs/en/ingest-management/elastic-agent/scaling-on-kubernetes.asciidoc

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ Setting the low priority to {agent} comparing to other pods might also result to
135135
Trying to prioritise the agent installation before rest of application microservices, https://github.com/elastic/elastic-agent/blob/main/docs/manifests/elastic-agent-managed-gke-autopilot.yaml#L8-L16[PriorityClasses suggested]
136136

137137
[discrete]
138-
=== {k8s} Policy Configuration
138+
=== {k8s} Package Configuration
139139

140140
Policy configuration of {k8s} package can heavily affect the amount of metrics collected and finally ingested. Factors that should be considered in order to make your collection and ingestion lighter:
141141

@@ -145,9 +145,21 @@ Policy configuration of {k8s} package can heavily affect the amount of metrics c
145145
- Disable events dataset
146146
- Disable {k8s} control plane datasets in Cloud managed {k8s} instances (see more info ** <<running-on-gke-managed-by-fleet>>, <<running-on-eks-managed-by-fleet>>, <<running-on-aks-managed-by-fleet>> pages)
147147

148+
149+
[discrete]
150+
=== Dashboards and Visualisations
151+
152+
The https://github.com/elastic/integrations/blob/main/docs/dashboard_guidelines.md[Dashboard Guidelines] document provides guidance on how to implement your dashboards and is constantly updated to track the needs of Observability at scale.
153+
148154
User experience regarding Dashboard responses, is also affected from the size of data being requested. As dashboards can contain multiple visualisations, the general consideration is to split visualisations and group them according to the frequency of access. The less number of visualisations tends to improve user experience.
149155

150-
Additionally, https://github.com/elastic/integrations/blob/main/docs/dashboard_guidelines.md[Dashboard Guidelines] is constantly updated also to track needs of observability at scale.
156+
[discrete]
157+
=== Disabling indexing host.ip and host.mac fields
158+
159+
A new environemntal variable `ELASTIC_NETINFO: false` has been introduced to globally disable the indexing of `host.ip` and `host.mac` fields in your {k8s} integration. For more information see <<agent-environment-variables>>.
160+
161+
Setting this to `false` is recommended for large scale setups where the `host.ip` and `host.mac` fields' index size increases. The number of IPs and MAC addresses reported increases significantly as a Kubenetes cluster grows. This leads to considerably increased indexing time, as well as the need for extra storage and additional overhead for visualization rendering.
162+
151163

152164
[discrete]
153165
=== Elastic Stack Configuration

0 commit comments

Comments
 (0)