feat: implement custom log fmter to strip APIKey #15
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
NagiosXI seems to only support using an API key as a URL parameter, which leads to leakage on errors stemming from HTTP requests, such as the scrape.uri not being a Nagios endpoint. This implmenets a custom logrus log formatter to strips the API key and replaces it with junk indicating the API key has been redacted - and therefore, keeping this keys out of logs. Output: ``` /usr/local/bin/prometheus-nagios-exporter --nagios.scrape-uri google.com INFO[0000] Using connection endpoint: google.com FATA[0003] Get "google.com/nagiosxi/api/v1/system/status?apikey=<redactedAPIKey>": unsupported protocol scheme "" ```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
NagiosXI seems to only support using an API key as a URL parameter, which leads to leakage on errors stemming from HTTP requests, such as the scrape.uri not being a Nagios endpoint.
This implements a custom logrus log formatter to strips the API key and replaces it with junk indicating the API key has been redacted - and therefore, keeping this keys out of logs.
Output:
Resolves #12