Skip to content

Commit

Permalink
[Azure Logs] Clarify event hub name field description (#9258)
Browse files Browse the repository at this point in the history
* Clarify event hub name field description

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]>
  • Loading branch information
zmoog and alaudazzi authored Apr 17, 2024
1 parent cf070cc commit 0284a6e
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 10 deletions.
7 changes: 6 additions & 1 deletion packages/azure/changelog.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
- version: "1.11.1"
changes:
- description: Update description for event hub parameter name recommendations.
type: enhancement
link: https://github.com/elastic/integrations/pull/9258
- version: "1.11.0"
changes:
- description: Use ecs definition of the 'event.dataset' field for eventhub
Expand Down Expand Up @@ -415,7 +420,7 @@
- description: Add spring cloud logs
type: enhancement
link: https://github.com/elastic/integrations/pull/1355
- version: '0.6.2'
- version: "0.6.2"
changes:
- description: update to ECS 1.11.0
type: enhancement
Expand Down
6 changes: 3 additions & 3 deletions packages/azure/manifest.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: azure
title: Azure Logs
version: 1.11.0
version: 1.11.1
description: This Elastic integration collects logs from Azure
type: integration
icons:
Expand All @@ -25,12 +25,12 @@ screenshots:
vars:
- name: eventhub
type: text
title: Event Hub
title: Event Hub Name
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.
- name: consumer_group
type: text
title: Consumer Group
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,6 @@
description: |
Autogenerated ID representing the fingerprint of the azure.dimensions object
dimension: true

- name: metrics.*.*
type: object
object_type: float
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -166,5 +166,5 @@
- name: os.codename
type: keyword
example: "stretch"
description: >
OS codename, if any.
description: >-
OS codename, if any.
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@
object_type: float
metric_type: gauge
object_type_mapping_type: "*"
description: >
storage account
description: >-
storage account
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,6 @@
type: keyword
dimension: true
description: Type of transaction. The available values include User and System.

- name: metrics.*.*
type: object
object_type: float
Expand Down

0 comments on commit 0284a6e

Please sign in to comment.