deploy/compose/README.md (1)

Line range hint 1-100: Document the HOPRD_API_PORT for metricspusher

The docker-compose.yml introduces a new environment variable HOPRD_API_PORT for the metricspusher service, but this change isn't reflected in the README. Consider adding this information to the metrics-push profile section.

Configuration used: .coderabbit.yaml
Review profile: CHILL

#!/bin/bash
# Description: Check if documentation mentions HOPRD_API_PORT

# Look for documentation files
fd -e md -e rst . | xargs rg "HOPRD_API_PORT|metricspusher"

# Check if there's a README in the deploy directory
cat deploy/README.md 2>/dev/null || echo "No README found in deploy directory"

#!/bin/bash
# Description: Check for dependencies between OpenTelemetry and metrics collection

# Look for any conditional logic based on HOPRD_USE_OPENTELEMETRY
rg "HOPRD_USE_OPENTELEMETRY" --type yaml --type sh

# Check if metrics endpoints are dependent on OpenTelemetry
rg "metrics.*endpoint" --type yaml --type sh

#!/bin/bash
# Let's check for any metrics-related configuration and usage

# Check for metrics-related environment variables in docker-compose
rg "HOPRD.*METRICS|METRICS.*PORT" --type yaml

# Look for metrics configuration in environment files
fd ".env" --exec cat {}

# Search for any metrics setup or collection logic
rg "metrics" -i --type yaml --type sh -A 3 -B 3

#!/bin/bash
# Let's check for metrics and telemetry configuration in environment files and docker compose

# Check for metrics and telemetry related variables in environment files
fd -e env -e env.sample -e env.example --exec cat {}

# Look for metrics and telemetry configuration in docker-compose
rg "HOPRD_API_PORT|HOPRD_USE_OPENTELEMETRY|metrics" -i --type yaml -A 2 -B 2 deploy/compose/docker-compose.yml

deploy/compose/prometheus/metricspusher.sh (1)

9-10: Consider adding health checks

The script might benefit from initial health checks before entering the main loop.

Consider adding a health check function:

 #!/bin/sh
 
+check_hoprd_health() {
+    for i in $(seq 1 30); do
+        if curl -s -f -H "X-Auth-Token: ${HOPRD_API_TOKEN}" "http://hoprd:${HOPRD_API_PORT}/api/v3/node/status" > /dev/null; then
+            return 0
+        fi
+        echo "Waiting for Hoprd API to be ready... (attempt ${i}/30)"
+        sleep 2
+    done
+    echo "Error: Hoprd API failed to become ready"
+    return 1
+}
+
+# Wait for Hoprd to be ready
+if ! check_hoprd_health; then
+    exit 1
+fi
+
 METRICS_PUSH_URL=${1}

Configuration used: .coderabbit.yaml
Review profile: CHILL

#!/bin/bash
# Description: Check if HOPRD_API_PORT is properly configured in docker-compose and .env files

# Check docker-compose files for HOPRD_API_PORT configuration
echo "Checking docker-compose files for HOPRD_API_PORT:"
rg -l "HOPRD_API_PORT" deploy/compose/

# Check .env files for HOPRD_API_PORT default value
echo -e "\nChecking .env files for HOPRD_API_PORT:"
rg "HOPRD_API_PORT" deploy/compose/.env*

#!/bin/bash
# Check docker-compose configuration for hoprd service and port mapping
echo "Checking docker-compose.yml for hoprd service configuration:"
cat deploy/compose/docker-compose.yml | grep -A 10 "hoprd:"

# Check if the port is properly exposed in the compose file
echo -e "\nChecking port exposures in docker-compose.yml:"
rg "3001:" deploy/compose/docker-compose.yml

# Check if there are any other references to the API port
echo -e "\nChecking other references to port 3001:"
rg "3001" deploy/compose/

deploy/compose/prometheus/metricspusher.sh (2)

Line range hint 1-8: Remove duplicate content at the beginning and end of the file

The file appears to have duplicate content from a merge or diff application issue. The first few lines and the last line should be removed as they're duplicated by the new content.

Apply this diff to fix the duplication:

-#!/bin/sh
-
-
-METRICS_PUSH_URL=${1}
-
-# Run the loop
-while true; do 
-    echo Publishing metrics ...
     sleep 15
done

Also applies to: 43-43

---

31-41: Consider enhancing error logging with timestamps

While the error handling is well implemented, adding timestamps to the log messages would help with debugging and monitoring.

Apply this diff to enhance the logging:

-        echo "Error: Failed to fetch metrics from Hoprd API"
+        echo "$(date -u '+%Y-%m-%d %H:%M:%S UTC') Error: Failed to fetch metrics from Hoprd API"
-        echo "Error: Failed to push metrics to ${METRICS_PUSH_URL}"
+        echo "$(date -u '+%Y-%m-%d %H:%M:%S UTC') Error: Failed to push metrics to ${METRICS_PUSH_URL}"

Configuration used: .coderabbit.yaml
Review profile: CHILL

#!/bin/bash
# Description: Check for any configuration or documentation about timeout values

# Look for timeout-related configuration in compose files
echo "Checking compose files for timeout configuration:"
fd -e yml -e yaml . deploy/compose/ --exec grep -l "timeout"

# Look for timeout documentation
echo "Checking documentation for timeout information:"
fd -e md . --exec grep -l "timeout"

#!/bin/bash
# Let's check the actual usage of metrics API in the codebase and any related timeout configurations

# Check the metrics pusher script for context
echo "Checking metrics pusher script:"
cat deploy/compose/prometheus/metricspusher.sh

# Search for any metrics-related API calls or configurations
echo -e "\nSearching for metrics API usage:"
rg -l "metrics" --type sh

# Look for any HTTP client timeout configurations in the codebase
echo -e "\nSearching for timeout configurations:"
rg -i "timeout.*metrics|metrics.*timeout"

deploy/compose/prometheus/metricspusher.sh (2)

15-18: Consider enhancing the error message with usage information.

While the validation is correct, the error message could be more helpful by including usage information.

 if [ -z "${METRICS_PUSH_URL}" ]; then
-    echo "Error: METRICS_PUSH_URL argument is required"
+    echo "Error: METRICS_PUSH_URL argument is required"
+    echo "Usage: $0 <metrics_push_url>"
     exit 1
 fi

---

23-33: Consider enhancing the error handling and configuration.

While the current implementation is good, here are some suggested improvements:

1. Make timeouts configurable via environment variables
2. Add retry mechanism for failed pushes
3. Make sleep intervals configurable

 #!/bin/sh

+# Default configuration
+CURL_TIMEOUT=${CURL_TIMEOUT:-10}
+RETRY_INTERVAL=${RETRY_INTERVAL:-5}
+PUSH_INTERVAL=${PUSH_INTERVAL:-15}
+MAX_RETRIES=${MAX_RETRIES:-3}

 # Validate required environment variables
 if [ -z "${HOPRD_API_TOKEN}" ]; then
     echo "Error: HOPRD_API_TOKEN is not set"
     exit 1
 fi

 # Run the loop
 while true; do 
     echo Publishing metrics ...
     # Add timeout and retry with backoff
-    if ! metrics=$(curl -s --max-time 10 -H "X-Auth-Token: ${HOPRD_API_TOKEN}" "http://hoprd:${HOPRD_API_PORT}/api/v3/node/metrics"); then
-        echo "Error: Failed to fetch metrics from Hoprd API"
-        sleep 5
-        continue
+    retries=0
+    while [ $retries -lt $MAX_RETRIES ]; do
+        if metrics=$(curl -s --max-time "$CURL_TIMEOUT" -H "X-Auth-Token: ${HOPRD_API_TOKEN}" "http://hoprd:${HOPRD_API_PORT}/api/v3/node/metrics"); then
+            break
+        fi
+        retries=$((retries + 1))
+        echo "Error: Failed to fetch metrics from Hoprd API (attempt $retries/$MAX_RETRIES)"
+        [ $retries -lt $MAX_RETRIES ] && sleep "$RETRY_INTERVAL"
+    done
+    
+    if [ $retries -eq $MAX_RETRIES ]; then
+        echo "Error: Failed to fetch metrics after $MAX_RETRIES attempts"
+        sleep "$PUSH_INTERVAL"
+        continue
     fi

     # Push metrics with timeout
-    if ! echo "${metrics}" | curl -s --max-time 10 --data-binary @- "${METRICS_PUSH_URL}"; then
-        echo "Error: Failed to push metrics to ${METRICS_PUSH_URL}"
+    retries=0
+    while [ $retries -lt $MAX_RETRIES ]; do
+        if echo "${metrics}" | curl -s --max-time "$CURL_TIMEOUT" --data-binary @- "${METRICS_PUSH_URL}"; then
+            break
+        fi
+        retries=$((retries + 1))
+        echo "Error: Failed to push metrics to ${METRICS_PUSH_URL} (attempt $retries/$MAX_RETRIES)"
+        [ $retries -lt $MAX_RETRIES ] && sleep "$RETRY_INTERVAL"
+    done
+    
+    if [ $retries -eq $MAX_RETRIES ]; then
+        echo "Error: Failed to push metrics after $MAX_RETRIES attempts"
     fi
-    sleep 15
+    sleep "$PUSH_INTERVAL"
 done

Configuration used: .coderabbit.yaml
Review profile: CHILL