Skip to content

Commit

Permalink
Merge pull request #17973 from josemore/jmore/infra-flex-troubleshooting
Browse files Browse the repository at this point in the history
docs: Flex basic troubleshooting steps
  • Loading branch information
bradleycamacho authored Jul 12, 2024
2 parents 39e725b + 306654b commit 42d71a7
Showing 1 changed file with 19 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,25 @@ Flex uses [infrastructure](/docs/infrastructure/install-infrastructure-agent/get

<InstallFeedback />

## Troubleshooting
When you encounter an issue with Flex configuration, first follow these basic troubleshooting steps:

* Test the configuration without the infrastructure agent: You can manually test a config file to ensure the output meets your expectations by running a command like this, replacing `<FILE_NAME>` with the name of your config file:

```
# Linux default path: /opt/newrelic-infra/newrelic-integrations/bin/
./nri-flex -verbose -pretty -config_path /etc/newrelic-infra/integrations.d/<FILE_NAME>
# Windows default path: C:\Program Files\New Relic\newrelic-infra\newrelic-integrations
.\nri-flex.exe -verbose -pretty -config_path "C:\Program Files\New Relic\newrelic-infra\integrations.d\<FILE_NAME>"
```

This will give you an output showing debug logging and JSON payload that will be integrated with the infrastucture agent. Make sure Flex is obtaining and formatting your telemetry as expected before continue with the rest of the troubleshooting steps. Learn more about testing Flex configurations from the [GitHub repository](https://github.com/newrelic/nri-flex/blob/master/docs/troubleshooting.md#testing-a-config).

* Test with the infrastructure agent in `dry-run` mode: Use the [dry-run flag](/docs/infrastructure/host-integrations/troubleshooting/run-integrations-manually/) in the infrastructure agent to test your Flex configuration. Verify the output contains the telemetry you expect to be reported to New Relic.

* Debug the integration with the infrastructure agent: Finally, ensure the agent is reporting the telemetry data as expected by [enabling debug logs](/docs/infrastructure/infrastructure-troubleshooting/troubleshoot-logs/generate-logs-troubleshooting-infrastructure/) in the infrastructure agent.

## Learn more [#get]

The Flex integration comes bundled with the infrastructure agent, and it can be configured like any other on-host integration. Learn more about [configuration options](/docs/infrastructure/host-integrations/infrastructure-integrations-sdk/specifications/host-integrations-standard-configuration-format).
Expand Down

0 comments on commit 42d71a7

Please sign in to comment.