[ibmmq_otel] IBM MQ Opentelemetry Assets#17896
Conversation
Vale Linting ResultsSummary: 4 warnings found
|
| File | Line | Rule | Message |
|---|---|---|---|
| packages/ibmmq_otel/docs/README.md | 5 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'. |
| packages/ibmmq_otel/docs/README.md | 34 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
| packages/ibmmq_otel/docs/README.md | 36 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
| packages/ibmmq_otel/docs/README.md | 37 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
The Vale linter checks documentation changes against the Elastic Docs style guide.
To use Vale locally or report issues, refer to Elastic style guide for Vale.
packages/ibmmq_otel/docs/README.md
Outdated
| The IBM MQ OpenTelemetry assets have been tested with: | ||
|
|
||
| - OpenTelemetry `prometheusreceiver` v0.146.0 from OpenTelemetry Collector Contrib. | ||
| - IBMMQ v9.4.5.0 |
There was a problem hiding this comment.
| - IBMMQ v9.4.5.0 | |
| - IBM MQ v9.4.5.0 |
| description: "IBM MQ Assets from OpenTelemetry Collector" | ||
| type: content | ||
| categories: | ||
| - message_queue |
There was a problem hiding this comment.
Add observability category
There was a problem hiding this comment.
Pull request overview
This PR introduces a new ibmmq_otel content package that ships Kibana assets (dashboards, alerting rule templates, and SLO templates) for monitoring IBM MQ metrics ingested via OpenTelemetry.
Changes:
- Add
ibmmq_otelpackage scaffold (manifest.yml,changelog.yml, docs, icons). - Add Kibana assets: 4 dashboards, 9 alerting rule templates, and 2 SLO templates.
- Add
_dev/shareddashboard definitions and update CODEOWNERS.
Reviewed changes
Copilot reviewed 19 out of 28 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/ibmmq_otel/manifest.yml | Defines the content package metadata, constraints, discovery dataset, screenshots, and icon. |
| packages/ibmmq_otel/changelog.yml | Adds initial changelog entry for version 0.1.0. |
| packages/ibmmq_otel/docs/README.md | Documents what the content pack provides and how to collect/export IBM MQ metrics via OTel. |
| packages/ibmmq_otel/img/ibmmq_otel_logo.svg | Adds the package icon. |
| packages/ibmmq_otel/img/ibmmq_overview.png | Adds screenshot referenced by the manifest. |
| packages/ibmmq_otel/img/ibmmq_resources.png | Adds screenshot referenced by the manifest. |
| packages/ibmmq_otel/img/ibmmq_message_traffic.png | Adds screenshot referenced by the manifest. |
| packages/ibmmq_otel/img/ibmmq_error_analysis.png | Adds screenshot referenced by the manifest. |
| packages/ibmmq_otel/kibana/dashboard/ibmmq_otel-overview.json | Adds the “[IBM MQ OTel] Overview” dashboard saved object. |
| packages/ibmmq_otel/kibana/dashboard/ibmmq_otel-message-traffic.json | Adds the “[IBM MQ OTel] Message Traffic” dashboard saved object. |
| packages/ibmmq_otel/kibana/dashboard/ibmmq_otel-error-analysis.json | Adds the “[IBM MQ OTel] Error Analysis” dashboard saved object. |
| packages/ibmmq_otel/kibana/dashboard/ibmmq_otel-resources.json | Adds the “[IBM MQ OTel] Resources & Performance” dashboard saved object. |
| packages/ibmmq_otel/kibana/alerting_rule_template/ibmmq_otel-cpu-load-high.json | Adds an ES |
| packages/ibmmq_otel/kibana/alerting_rule_template/ibmmq_otel-expired-messages.json | Adds an ES |
| packages/ibmmq_otel/kibana/alerting_rule_template/ibmmq_otel-failed-connections.json | Adds an ES |
| packages/ibmmq_otel/kibana/alerting_rule_template/ibmmq_otel-failed-message-operations.json | Adds an ES |
| packages/ibmmq_otel/kibana/alerting_rule_template/ibmmq_otel-fdc-files-increasing.json | Adds an ES |
| packages/ibmmq_otel/kibana/alerting_rule_template/ibmmq_otel-high-log-write-latency.json | Adds an ES |
| packages/ibmmq_otel/kibana/alerting_rule_template/ibmmq_otel-high-rollback-ratio.json | Adds an ES |
| packages/ibmmq_otel/kibana/alerting_rule_template/ibmmq_otel-log-filesystem-critically-low.json | Adds an ES |
| packages/ibmmq_otel/kibana/alerting_rule_template/ibmmq_otel-queue-manager-filesystem-low.json | Adds an ES |
| packages/ibmmq_otel/kibana/slo_template/ibmmq_otel-log-write-latency-99.5-Rolling30Days.json | Adds SLO template for log write latency objective. |
| packages/ibmmq_otel/kibana/slo_template/ibmmq_otel-message-put-availability-99.5-Rolling30Days.json | Adds SLO template for MQPUT/MQPUT1 availability objective. |
| packages/ibmmq_otel/_dev/shared/ibmmq-overview.yaml | Adds source YAML used to generate/maintain the Overview dashboard. |
| packages/ibmmq_otel/_dev/shared/ibmmq-message-traffic.yaml | Adds source YAML used to generate/maintain the Message Traffic dashboard. |
| packages/ibmmq_otel/_dev/shared/ibmmq-error-analysis.yaml | Adds source YAML used to generate/maintain the Error Analysis dashboard. |
| packages/ibmmq_otel/_dev/shared/ibmmq-resources.yaml | Adds source YAML used to generate/maintain the Resources & Performance dashboard. |
| .github/CODEOWNERS | Adds CODEOWNERS entry for the new package directory. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| "type": "number", | ||
| "esType": "long" |
There was a problem hiding this comment.
The attributes.qmgr column is a string (queue manager name), but this Lens/ES|QL column definition marks it as a numeric (meta.type: number, meta.esType: long). This can cause the datatable to mis-render or error at runtime. Remove the numeric meta for this column (as done for other string dimensions) or set it to a string/keyword type.
| "type": "number", | |
| "esType": "long" | |
| "type": "string", | |
| "esType": "keyword" |
| "type": "number", | ||
| "esType": "long" |
There was a problem hiding this comment.
The attributes.qmgr column is used as a dimension (queue manager name), but it is annotated as a numeric (meta.type: number, meta.esType: long). This likely conflicts with the ES|QL result type and can break the datatable. Remove the numeric meta for this column or change it to a string/keyword type.
| "type": "number", | |
| "esType": "long" | |
| "type": "string", | |
| "esType": "keyword" |
| "meta": { | ||
| "type": "number", | ||
| "esType": "long" | ||
| }, |
There was a problem hiding this comment.
attributes.qmgr represents the queue manager name (string), but this column is declared as numeric (meta.type: number, meta.esType: long). This mismatch can cause the Lens datatable to fail type validation. Remove the meta block for this column (or set it to string/keyword).
| "meta": { | |
| "type": "number", | |
| "esType": "long" | |
| }, |
| "type": "number", | ||
| "esType": "long" |
There was a problem hiding this comment.
The datatable defines attributes.qmgr (queue manager name) with numeric metadata (meta.type: number, meta.esType: long). Since ES|QL will return this as a string, this metadata should be removed or corrected to a string/keyword type to avoid rendering/runtime issues.
| "type": "number", | |
| "esType": "long" | |
| "type": "string", | |
| "esType": "keyword" |
packages/ibmmq_otel/docs/README.md
Outdated
| The IBM MQ OpenTelemetry assets have been tested with: | ||
|
|
||
| - OpenTelemetry `prometheusreceiver` v0.146.0 from OpenTelemetry Collector Contrib. | ||
| - IBMMQ v9.4.5.0 |
There was a problem hiding this comment.
Spelling/branding: the compatibility list uses "IBMMQ"; this should be "IBM MQ" for consistency with the rest of the document.
| - IBMMQ v9.4.5.0 | |
| - IBM MQ v9.4.5.0 |
| description: "IBM MQ Assets from OpenTelemetry Collector" | ||
| type: content | ||
| categories: | ||
| - message_queue |
There was a problem hiding this comment.
For consistency with other OpenTelemetry content packs, consider adding the observability category (e.g. packages/rabbitmq_otel/manifest.yml includes message_queue, observability, opentelemetry). This improves discoverability in the Integrations UI.
| - message_queue | |
| - message_queue | |
| - observability |
💚 Build Succeeded
History
cc @ritalwar |
|
Package ibmmq_otel - 0.1.0 containing this change is available at https://epr.elastic.co/package/ibmmq_otel/0.1.0/ |
Proposed commit message
This PR adds IBM MQ Otel content pack which include assets like dashboards, alert_rule_templates and slo_template.
Checklist
changelog.ymlfile.Author's Checklist
How to test this PR locally
Related issues
Screenshots