[Azure Logs] Clarify event hub name field description #9258
Conversation
zmoog
added
enhancement
🚀 Benchmarks reportTo see the full report comment with |
|
|
Hi! We just realized that we haven't looked into this PR in a while. We're sorry! We're labeling this issue as |
packages/azure/manifest.yml
Outdated
| multi: false | ||
| required: true | ||
| show_user: true | ||
| description: >- | ||
| Elastic recommends using one event hub for each integration. Visit [Create an event hub](https://docs.elastic.co/integrations/azure#create-an-event-hub) to learn more. Use event hub names up to 30 characters long to avoid compatibility issues. | ||
| The event hub name that contains the logs to ingest. Do NOT use the event hub namespace here. Elastic recommends using one event hub for each integration. Visit [Create an event hub](https://docs.elastic.co/integrations/azure#create-an-event-hub) to learn more. Use event hub names up to 30 characters long to avoid compatibility issues. |
There was a problem hiding this comment.
Small suggestion on this line,
The event hub name that contains the logs to ingest.
Can we rename like,
The name of the event hub that contains the logs to ingest.
Recent feedback indicates confusion among users who mistakenly input the Event Hub Namespace instead of the Event Hub Name in the relevant field. To address this and enhance user understanding, this commit makes the following adjustments to the field's description: - Clearly defines the purpose of the field: Specifies that users should enter the name of the Event Hub they wish to connect to. - Delineates what the field is not for: Explicitly states that this field is not intended for the Event Hub Namespace name. This distinction is crucial to prevent the recurrence of the confusion and to ensure that the field is used as intended.
Co-authored-by: Arianna Laudazzi <[email protected]>
zmoog
force-pushed
the
zmoog/improve-eventhub-name-var-description
branch
from
2452b7e to
9aee86d
Compare
💚 Build Succeeded
History
cc @zmoog |
|
|
Package azure - 1.11.1 containing this change is available at https://epr.elastic.co/search?package=azure |
andrewkroh
added
Integration:azure
Proposed commit message
Recent feedback indicates confusion among a few users who mistakenly
used the Event Hub Namespace instead of the Event Hub Name in the
field.
To address this and enhance user understanding, this PR makes the
following adjustments to the field's description:
should enter the name of the Event Hub they wish to connect to.
this field is not intended for the Event Hub Namespace name.
This distinction is crucial to prevent the recurrence of the
confusion and to ensure that the field is used as intended.
Checklist
I have verified that all data streams collect metrics or logs.changelog.ymlfile.I have verified that Kibana version constraints are current according to guidelines.Screenshots