feat: Add NRDOT IBM MQ install recipe (#1386)

Co-authored-by: pranav-new-relic <pnandula@newrelic.com>

Author: shashank-reddy-nr

recipes/newrelic/infrastructure/nrdot/ibm-mq/debian.yml

@@ -0,0 +1,281 @@
+# Visit our schema definition for additional information on this file format.
+# https://github.com/newrelic/open-install-library/blob/main/docs/recipe-spec/recipe-spec.md#schema-definition
+
+name: nrdot-collector-ibm-mq
+displayName: NRDOT Collector - IBM MQ
+description: New Relic install recipe for IBM MQ monitoring via NRDOT Collector on Debian/Ubuntu.
+repository: https://github.com/newrelic/nrdot-collector-releases
+
+installTargets:
+  - type: host
+    os: linux
+    platformFamily: debian
+  - type: host
+    os: linux
+    platform: ubuntu
+
+keywords:
+  - IBM MQ
+  - IBMMQ
+  - NRDOT
+  - OpenTelemetry
+  - OTel
+  - Messaging
+  - Queue
+  - Linux
+  - Debian
+  - Ubuntu
+
+processMatch: []
+
+preInstall:
+  discoveryMode:
+    - targeted
+
+inputVars:
+  - name: NR_CLI_IBMMQ_EXPORTER_ENDPOINT
+    prompt: "IBM MQ Prometheus exporter address (mq-metric-samples, e.g. localhost:9157): "
+    default: "localhost:9157"
+  - name: NR_CLI_IBMMQ_CLUSTER_NAME
+    prompt: "IBM MQ cluster name (optional, press Enter to skip): "
+    default: ""
+
+validationNrql: "SELECT count(*) FROM Metric WHERE metricName LIKE 'ibmmq_%' AND instrumentation.provider = 'opentelemetry' SINCE 10 minutes ago"
+
+install:
+  version: "3"
+  silent: true
+
+  vars:
+    IS_SYSTEMCTL:
+      sh: command -v systemctl | wc -l
+    NRDOT_ARCH:
+      sh: if [ "$(uname -m)" = "aarch64" ]; then echo "arm64"; else echo "amd64"; fi
+    COLLECTOR_DISTRO: "nrdot-collector"
+    CONFIG_DIR: "/etc/nrdot-collector"
+
+  tasks:
+    default:
+      cmds:
+        - task: write_recipe_metadata
+        - task: assert_pre_req
+        - task: install_nrdot
+        - task: create_collector_config
+        - task: configure_service
+        - task: restart_nrdot
+        - task: assert_nrdot_status_ok
+
+    write_recipe_metadata:
+      cmds:
+        - |
+          echo '{"Metadata":{"CapturedCliOutput":"true"}}' | tee {{.NR_CLI_OUTPUT}} > /dev/null
+
+    assert_pre_req:
+      cmds:
+        - |
+          if [ "$(id -u)" != "0" ]; then
+            echo "This newrelic install must be run under sudo or root" >&2
+            exit 3
+          fi
+        - |
+          if ! command -v curl > /dev/null 2>&1; then
+            echo "curl is required to run the newrelic install. Please install curl and re-run the installation." >&2
+            exit 16
+          fi
+        - |
+          if [ "{{.IS_SYSTEMCTL}}" -eq 0 ]; then
+            echo "systemd is required for the nrdot-collector service configuration." >&2
+            exit 131
+          fi
+        - |
+          # Config-only recipe: verify the existing mq_prometheus exporter is serving ibmmq_*.
+          ENDPOINT="{{.NR_CLI_IBMMQ_EXPORTER_ENDPOINT}}"
+          if ! curl -sf "http://${ENDPOINT}/metrics" 2>/dev/null | grep -q "^ibmmq_"; then
+            echo "" >&2
+            echo "Could not read IBM MQ metrics from the exporter at http://${ENDPOINT}/metrics" >&2
+            echo "Make sure the mq-metric-samples (mq_prometheus) exporter is running and serving" >&2
+            echo "ibmmq_* metrics, then re-run. Setup: https://github.com/ibm-messaging/mq-metric-samples" >&2
+            exit 132
+          fi
+
+    install_nrdot:
+      cmds:
+        - |
+          # Resolve the latest release into a variable and fail fast if it is empty.
+          # (A pipeline's trailing `|| fallback` only guards the last command, so an
+          # empty API response would otherwise yield an empty version and a broken
+          # download URL that fails much later at dpkg with a misleading error.)
+          NRDOT_VERSION=$(curl -sf "https://api.github.com/repos/newrelic/nrdot-collector-releases/releases/latest" | grep '"tag_name"' | head -1 | cut -d '"' -f 4 | sed 's/^v//')
+          if [ -z "$NRDOT_VERSION" ]; then
+            echo "Could not determine the latest nrdot-collector release from GitHub (network issue or API rate limit). Please re-run the installation." >&2
+            exit 1
+          fi
+          # Idempotent: skip the download if this version is already installed.
+          if dpkg -l | grep -q "^ii.*{{.COLLECTOR_DISTRO}} "; then
+            INSTALLED_VERSION=$(dpkg -l {{.COLLECTOR_DISTRO}} | awk '/^ii/{print $3}' | sed 's/^[0-9]*://')
+            if [ "$INSTALLED_VERSION" = "$NRDOT_VERSION" ]; then
+              echo "{{.COLLECTOR_DISTRO}} $NRDOT_VERSION is already installed. Skipping download."
+              exit 0
+            fi
+          fi
+          echo "Installing NRDOT Collector v$NRDOT_VERSION..."
+          NRDOT_DEB="/tmp/{{.COLLECTOR_DISTRO}}_${NRDOT_VERSION}_linux_{{.NRDOT_ARCH}}.deb"
+          curl -fL --output "$NRDOT_DEB" \
+            "https://github.com/newrelic/nrdot-collector-releases/releases/download/${NRDOT_VERSION}/{{.COLLECTOR_DISTRO}}_${NRDOT_VERSION}_linux_{{.NRDOT_ARCH}}.deb"
+          if [ $? -ne 0 ]; then
+            echo "Failed to download the NRDOT Collector package (version ${NRDOT_VERSION}, arch {{.NRDOT_ARCH}})." >&2
+            exit 1
+          fi
+          DEBIAN_FRONTEND=noninteractive dpkg -i "$NRDOT_DEB" > /dev/null
+          if [ $? -ne 0 ]; then
+            apt-get -o DPkg::Lock::Timeout=60 install -f -y > /dev/null
+            if [ $? -ne 0 ]; then
+              echo "Failed to install NRDOT Collector package." >&2
+              exit 1
+            fi
+          fi
+          rm -f "$NRDOT_DEB"
+
+    create_collector_config:
+      cmds:
+        - |
+          COLLECTOR_CONFIG="{{.CONFIG_DIR}}/ibmmq-collector-config.yaml"
+          ENV_FILE="{{.CONFIG_DIR}}/ibmmq-env.conf"
+          mkdir -p "{{.CONFIG_DIR}}"
+
+          # Config uses ${env:...} expansion; values come from the env file below
+          # (no in-place edits). target.name is derived from the detected host.id.
+          cat > "$COLLECTOR_CONFIG" << 'EOF'
+          extensions:
+            health_check:
+              endpoint: 0.0.0.0:13133
+          receivers:
+            prometheus/ibmmq:
+              config:
+                scrape_configs:
+                  - job_name: 'ibmmq'
+                    scrape_interval: 60s
+                    scrape_timeout: 15s
+                    static_configs:
+                      - targets: ['${env:IBMMQ_EXPORTER_ENDPOINT}']
+          processors:
+            resourcedetection:
+              detectors: [env, ec2, gcp, azure, system]
+              system:
+                resource_attributes:
+                  host.id:
+                    enabled: true
+                  host.name:
+                    enabled: true
+            filter/ibmmq-overhead:
+              metrics:
+                exclude:
+                  match_type: regexp
+                  metric_names:
+                    - "^go_.*"
+                    - "^process_.*"
+                    - "^promhttp_.*"
+                    - "^scrape_.*"
+            filter/ibmmq-queues:
+              metrics:
+                datapoint:
+                  - 'attributes["queue"] != nil and IsMatch(attributes["queue"], "^SYSTEM[.](ADMIN[.]|MQSC[.]|DEFAULT[.]|AUTH[.]|CHANNEL[.]|CHLAUTH[.]|CICS[.]|SYNCPOINT[.]|INTERNAL[.]|PENDING[.]|PROTECTION[.]|BROKER[.]|AMQP[.]|DOTNET[.]|REST[.]|RETAINED[.]|SELECTION[.]|DURABLE[.]|HIERARCHY[.]|DDELAY[.])")'
+                  - 'attributes["queue"] != nil and IsMatch(attributes["queue"], "^SYSTEM[.]CLUSTER[.](COMMAND|HISTORY)[.]QUEUE$")'
+                  - 'attributes["queue"] != nil and IsMatch(attributes["queue"], "^AMQ[.]")'
+            transform/ibmmq-cleanup:
+              metric_statements:
+                - context: resource
+                  statements:
+                    - set(attributes["target.name"], attributes["host.id"]) where attributes["host.id"] != nil
+                    - set(attributes["cluster.name"], "${env:IBMMQ_CLUSTER_NAME}") where "${env:IBMMQ_CLUSTER_NAME}" != ""
+                    - delete_key(attributes, "service.name")
+                    - delete_key(attributes, "url.scheme")
+                - context: datapoint
+                  statements:
+                    - delete_key(attributes, "instance")
+                    - delete_key(attributes, "job")
+            memory_limiter/ibmmq:
+              check_interval: 1s
+              limit_mib: 512
+              spike_limit_mib: 256
+            cumulativetodelta/ibmmq: {}
+            batch/ibmmq:
+              send_batch_size: 1000
+              timeout: 200ms
+          exporters:
+            otlp/ibmmq:
+              endpoint: ${env:NEW_RELIC_OTLP_ENDPOINT}
+              headers:
+                api-key: ${env:NEW_RELIC_LICENSE_KEY}
+              compression: gzip
+          service:
+            extensions: [health_check]
+            pipelines:
+              metrics/ibmmq:
+                receivers: [prometheus/ibmmq]
+                processors: [memory_limiter/ibmmq, resourcedetection, filter/ibmmq-overhead, filter/ibmmq-queues, transform/ibmmq-cleanup, cumulativetodelta/ibmmq, batch/ibmmq]
+                exporters: [otlp/ibmmq]
+          EOF
+
+          if [ "{{.NEW_RELIC_REGION}}" = "EU" ]; then
+            OTLP_ENDPOINT="https://otlp.eu01.nr-data.net:4317"
+          elif [ "{{.NEW_RELIC_REGION}}" = "staging" ]; then
+            OTLP_ENDPOINT="https://staging-otlp.nr-data.net:4317"
+          elif [ "{{.NEW_RELIC_REGION}}" = "JP" ]; then
+            OTLP_ENDPOINT="https://otlp.jp.nr-data.net:4317"
+          else
+            OTLP_ENDPOINT="https://otlp.nr-data.net:4317"
+          fi
+
+          printf "IBMMQ_EXPORTER_ENDPOINT=%s\n" "{{.NR_CLI_IBMMQ_EXPORTER_ENDPOINT}}" > "$ENV_FILE"
+          printf "IBMMQ_CLUSTER_NAME=%s\n" "{{.NR_CLI_IBMMQ_CLUSTER_NAME}}" >> "$ENV_FILE"
+          printf "NEW_RELIC_OTLP_ENDPOINT=%s\n" "$OTLP_ENDPOINT" >> "$ENV_FILE"
+          printf "NEW_RELIC_LICENSE_KEY=%s\n" "{{.NEW_RELIC_LICENSE_KEY}}" >> "$ENV_FILE"
+          chmod 600 "$ENV_FILE"
+          echo "Collector config written to $COLLECTOR_CONFIG"
+
+    configure_service:
+      cmds:
+        - |
+          DROPIN_DIR="/etc/systemd/system/{{.COLLECTOR_DISTRO}}.service.d"
+          mkdir -p "$DROPIN_DIR"
+          NRDOT_BIN=$(command -v {{.COLLECTOR_DISTRO}} 2>/dev/null || echo "/usr/bin/{{.COLLECTOR_DISTRO}}")
+          {
+            printf '[Service]\n'
+            printf 'EnvironmentFile={{.CONFIG_DIR}}/ibmmq-env.conf\n'
+            printf 'ExecStart=\n'
+            printf 'ExecStart=%s --config {{.CONFIG_DIR}}/ibmmq-collector-config.yaml\n' "$NRDOT_BIN"
+          } > "$DROPIN_DIR/ibmmq-config.conf"
+          echo "Systemd drop-in configured."
+
+    restart_nrdot:
+      cmds:
+        - |
+          systemctl daemon-reload
+          systemctl enable {{.COLLECTOR_DISTRO}}.service
+          systemctl restart {{.COLLECTOR_DISTRO}}.service
+
+    assert_nrdot_status_ok:
+      cmds:
+        - |
+          MAX_RETRIES=30
+          TRIES=0
+          echo "Waiting for NRDOT Collector to start..."
+          while [ $TRIES -lt $MAX_RETRIES ]; do
+            TRIES=$((TRIES + 1))
+            if systemctl is-active --quiet {{.COLLECTOR_DISTRO}}.service && curl -sf http://localhost:13133 > /dev/null 2>&1; then
+              echo "NRDOT Collector is running and healthy."
+              exit 0
+            fi
+            sleep 2
+          done
+          echo "NRDOT Collector did not start in time." >&2
+          journalctl -u {{.COLLECTOR_DISTRO}}.service --no-pager -n 50 >&2
+          exit 31
+
+postInstall:
+  info: |2
+      IBM MQ OTel Collector config: /etc/nrdot-collector/ibmmq-collector-config.yaml
+      Environment file:             /etc/nrdot-collector/ibmmq-env.conf
+      Service status: systemctl status nrdot-collector
+      View logs:      journalctl -u nrdot-collector -f