Interactive mode (CLI) + Prometheus

[skudasov]

---

Below is a summarization created by an LLM (gpt-4-0125-preview). Be mindful of hallucinations and verify accuracy.

Why

The changes improve documentation, enhance functionality for non-technical users, integrate new observability metrics, and update the testing framework for Chainlink nodes. These modifications enhance the user experience, provide better insights into system performance, and ensure compatibility and ease of use for a broader audience.

What

• .github/workflows/docs.yml

  • Commented out the branch trigger for main, likely to prevent automatic actions on main branch changes.

• book/src/SUMMARY.md

  • Added link to new "Metrics" document.
  • Added link to a new "Interactive" document for non-technical users or those not using Golang.

• book/src/framework/images/interactive-node-set.png

  • Added a new image file supporting documentation for interactive node sets.

• book/src/framework/interactive.md

  • Created a new markdown file providing guidance on deploying NodeSets interactively, catering to non-technical users.

• book/src/framework/observability/metrics.md

  • Provided a new markdown file detailing how Prometheus is used to collect metrics from Chainlink nodes and services.

• book/src/overview.md

  • Revised to include non-technical users, directing them to the new "Interactive" section for assistance.

• framework/cmd/interactive.go

  • Introduced a new Go file implementing interactive environment building commands, enabling non-technical users to easily set up NodeSets.

• framework/cmd/main.go

  • Added "build" command with a subcommand "node_set" for interactive NodeSet creation.

• framework/cmd/observability/compose/conf/prometheus.yml

  • Modified scrape configuration, adjusting the refresh interval and simplifying the relabel_configs section.

• framework/cmd/observability/compose/conf/provisioning/datasources/loki.yaml

  • Added a Prometheus data source configuration.

• framework/cmd/observability/compose/docker-compose.yaml

  • Adjusted Prometheus service configuration to run as a specific user and added volume mapping for Docker socket.

• framework/components/clnode/clnode_test.go

  • Updated to use a simplified network setup method call, removing the test-specific parameter.

• framework/components/simple_node_set/node_set.go

  • Enhanced logging to include node index when printing Chainlink node URLs.

• framework/components/simple_node_set/nodeset_test.go

  • Similar to clnode_test.go, updated for simplified network setup.

• framework/config.go

  • Implemented a correction in network setup function to properly initialize network only once and manage errors appropriately.

• framework/docker.go

  • Introduced a utility function to check if Docker daemon is running, enhancing error handling and setup processes.

• framework/go.mod & framework/go.sum

  • Updated module dependencies, adding new packages required for the interactive command implementation and observability enhancements.

[cl-sonarqube-production]

Quality Gate passed

Issues
3 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.9% Duplication on New Code

See analysis details on SonarQube