-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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
[exporter/bmchelix] New component: BMC Helix Exporter #36964
base: main
Are you sure you want to change the base?
[exporter/bmchelix] New component: BMC Helix Exporter #36964
Conversation
* Go init * Added README.md and code skeleton.
* Updated go version to 1.22.0 in the go.mod file.
* Fixed dependency versions in go.mod
exporter/bmchelixexporter/config.go
Outdated
if c.ApiKey == "" { | ||
return errors.New("api key is required") | ||
} | ||
if c.Timeout < 0 { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If timeout must be a positive integer, then I think it should be if c.Timeout <= 0
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch!
* Fixed timeout positive integer check.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Review TBC
exporter/bmchelixexporter/README.md
Outdated
- `entityTypeId`: Type identifier for the entity. | ||
- `instanceName`: Display name of the entity. | ||
|
||
> **Note:** If `entityName` or `entityTypeId` is missing, the metric will not be populated. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
> **Note:** If `entityName` or `entityTypeId` is missing, the metric will not be populated. | |
> **Note:** If `entityName` or `entityTypeId` is missing, the metric will not be exported. | |
To ensure the necessary attributes are not present, it is recommended to leverage the [transform processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/transformprocessor) with [OTTL](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/pkg/ottl), and include it in the configuration of the telemetry pipeline. | |
The minimal pipeline most often looks like: `OTEL metrics --> (batch/memory limit) --> transform processor --> bmchelix exporter`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
are present, ...
exporter/bmchelixexporter/README.md
Outdated
- `entityTypeId`: Type identifier for the entity. | ||
- `instanceName`: Display name of the entity. | ||
|
||
> **Note:** If `entityName` or `entityTypeId` is missing, the metric will not be populated. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
are present, ...
* Apply suggestions from code review Co-authored-by: Bertrand Martin <[email protected]>
exporter/bmchelixexporter/README.md
Outdated
enabled: true | ||
``` | ||
|
||
### Resource to Telemetry Conversion |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This option (resource_to_telemetry_conversion
) should probably be removed as it's difficult to understand and is pretty useless in BMC Helix use case.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The go module should be updated
go: updates to go.mod needed; to update it:
go mod tidy
/home/runner/work/opentelemetry-collector-contrib/opentelemetry-collector-contrib/.tools/govulncheck ./...
govulncheck: loading packages: err: exit status 1: stderr: go: updates to go.mod needed; to update it:
go mod tidy
Thanks a lot @fatsheep9146, I am updating the component..., I just need to adjust the configuration a bit to remove the |
…ew-component-bmc-helix-exporter
* Updated go module * Removed the resource_to_telemetry_conversion option
* Update: go.opentelemetry.io/collector/confmap v1.23.0
* Fixed ApiKey var naming (APIKey)
Description
This pull request introduces a new component for exporting metrics to BMC Helix. The changes include adding the new component to various configuration files, creating necessary documentation, and implementing the component's configuration and factory logic.
Key changes include:
New Component Addition:
.chloggen/bmchelixexporter-new-component.yaml
..github/CODEOWNERS
to include the new BMC Helix exporter.Documentation:
README.md
for the BMC Helix exporter with detailed setup instructions and examples.Configuration and Factory Implementation:
config.go
.config_test.go
.factory.go
.factory_test.go
.Miscellaneous:
exporter/bmchelixexporter/Makefile
.doc.go
.Link to tracking issue
Fixes #36773