Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding information for NETINFO environmental variable #463

Merged
merged 8 commits into from
Sep 12, 2023
Merged

Conversation

gizas
Copy link
Contributor

@gizas gizas commented Sep 6, 2023

Adding documentation information for NETINFO envrionmental variable introdused in this PR: elastic/beats#36506

@mergify
Copy link

mergify bot commented Sep 6, 2023

This pull request does not have a backport label. Could you fix it @gizas? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
    NOTE: backport-skip has been added to this pull request.

`NETINFO`

| (bool) When `false`, disables `netinfo.enabled` parameter of `add_host_metadata` processor.
Setting this to `false` is recommended for large scale setups where the host.ip and host.mac fields index size increases.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets add some more details here around what the problem is -> tons of ip addresses, tons of storage needed, slower queries

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. Let me know if is ok

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can still add more details here but lets do this as a follow up.

[discrete]
=== Disabling indexing host.ip and host.mac fields

A new environemntal variable `NETINFO: false` has been introduced to globally disable the indexing of fields `host.ip` and `host.mac` in your {k8s} integration. For more information see <<agent-environment-variables>>.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it disable indexing all host.ip fields or just reduces the number?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Disables them

@gizas
Copy link
Contributor Author

gizas commented Sep 7, 2023

Set default value ELASTIC_NETINFO: false as per discussion here elastic/beats#36506 (comment)

@bmorelli25 bmorelli25 requested review from a team and removed request for bmorelli25 September 7, 2023 18:57
Copy link
Contributor

@kilfoyle kilfoyle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Just a few suggestions for the text.

@gizas
Copy link
Contributor Author

gizas commented Sep 12, 2023

Any other suggestions or please can I have an approval here?

`NETINFO`

| (bool) When `false`, disables `netinfo.enabled` parameter of `add_host_metadata` processor.
Setting this to `false` is recommended for large scale setups where the host.ip and host.mac fields index size increases.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can still add more details here but lets do this as a follow up.

@gizas gizas merged commit 0c902bb into main Sep 12, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants