Skip to content

Commit 14d6d67

Browse files
authored
[chore] Update Azure Event Hub Receiver Documentation (#28623)
**Description:** <Describe what has changed.> <!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> The Documentation surrounding Azure Event Hub Metric creation is out-of-date or not accurate. **Link to tracking Issue:** <Issue number if applicable> #28622 **Testing:** <Describe what testing was performed and which tests were added.> No code was modified, only documentation. **Documentation:** <Describe the documentation added.> Updated the README.md in reciever/azureeventhub to be more accurate and improved the Metric mapping table to be consistent with the Log section.
1 parent db1c463 commit 14d6d67

File tree

2 files changed

+43
-15
lines changed

2 files changed

+43
-15
lines changed
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Use this changelog template to create an entry for release notes.
2+
3+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
4+
change_type: bug_fix
5+
6+
# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
7+
component: azureeventhubreceiver
8+
9+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
10+
note: Updated documentation around Azure Metric to OTel mapping.
11+
12+
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
13+
issues: [28622]
14+
15+
# (Optional) One or more lines of additional information to render under the primary note.
16+
# These lines will be padded with 2 spaces and then inserted directly into the document.
17+
# Use pipe (|) for multiline entries.
18+
subtext:
19+
20+
# If your change doesn't affect end users or the exported elements of any package,
21+
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
22+
# Optional: The change log or logs in which this entry should be included.
23+
# e.g. '[user]' or '[user, api]'
24+
# Include 'user' if the change is relevant to end users.
25+
# Include 'api' if there is a change to a library API.
26+
# Default: '[user]'
27+
change_logs: []

receiver/azureeventhubreceiver/README.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -100,20 +100,21 @@ JSON numbers are encoded as doubles.
100100
For Metrics the Azure Metric Records are an array
101101
of "records" with the following fields.
102102
103-
| Azure |
104-
|------------|
105-
| time |
106-
| resourceId |
107-
| metricName |
108-
| timeGrain |
109-
| total |
110-
| count |
111-
| minimum |
112-
| maximum |
113-
| average |
114-
115-
From this data a Metric of type Summary is created
116-
with a single Data Point that represents the value
117-
from the "total" field.
103+
| Azure | Open Telemetry |
104+
|------------|---------------------------------------------|
105+
| time | time_unix_nano (field) |
106+
| resourceId | azure.resource.id (resource attribute) |
107+
| metricName | |
108+
| timeGrain | start_time_unix_nano (field) |
109+
| total | mapped to datapoint metricName + "_TOTAL" |
110+
| count | mapped to datapoint metricName + "_COUNT" |
111+
| minimum | mapped to datapoint metricName + "_MINIMUM" |
112+
| maximum | mapped to datapoint metricName + "_MAXIMUM" |
113+
| average | mapped to datapoint metricName + "_AVERAGE" |
114+
115+
From this data a Metric of type Gauge is created
116+
with a Data Points that represents the values
117+
for the Metric including: Total, Minimum, Maximum,
118+
Average and Count.
118119
119120
[storage extension]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/storage

0 commit comments

Comments
 (0)