diff --git a/docs/reporters/ApiReporter.md b/docs/reporters/ApiReporter.md index b6bc3f59fab..1b688e05653 100644 --- a/docs/reporters/ApiReporter.md +++ b/docs/reporters/ApiReporter.md @@ -36,7 +36,63 @@ API_REPORTER_BEARER_TOKEN=DDHGHfgfgjfhQESRDTHFKGKHFswgFHDHGDH Example of logs sent to Loki: ```json -TODO +{ + "streams": [ + { + "stream": { + "source": "MegaLinter", + "gitRepoName": "megalinter", + "gitBranchName": "alpha", + "gitIdentifier": "megalinter/alpha", + "orgIdentifier": "alpha", + "descriptor": "API", + "linter": "spectral", + "linterKey": "API_SPECTRAL" + }, + "values": [ + [ + "1723831050362439098", + "{\"linterDocUrl\": \"https://megalinter.io/latest/descriptors/api_spectral\", \"jobUrl\": \"\", \"severity\": \"success\", \"severityIcon\": \"\\u2705\", \"cliLintMode\": \"file\", \"numberFilesFound\": 1, \"numberErrorsFound\": 0, \"elapsedTime\": 1.54}" + ] + ] + }, + { + "stream": { + "source": "MegaLinter", + "gitRepoName": "megalinter", + "gitBranchName": "alpha", + "gitIdentifier": "megalinter/alpha", + "orgIdentifier": "alpha", + "descriptor": "BASH", + "linter": "shellcheck", + "linterKey": "BASH_SHELLCHECK" + }, + "values": [ + [ + "1723831050362439098", + "{\"linterDocUrl\": \"https://megalinter.io/latest/descriptors/bash_shellcheck\", \"jobUrl\": \"\", \"severity\": \"success\", \"severityIcon\": \"\\u2705\", \"cliLintMode\": \"list_of_files\", \"numberFilesFound\": 5, \"numberErrorsFound\": 0, \"elapsedTime\": 0.14}" + ] + ] + }, + { + "stream": { + "source": "MegaLinter", + "gitRepoName": "megalinter", + "gitBranchName": "alpha", + "gitIdentifier": "megalinter/alpha", + "orgIdentifier": "alpha", + "descriptor": "MARKDOWN", + "linter": "markdownlint", + "linterKey": "MARKDOWN_MARKDOWNLINT" + }, + "values": [ + [ + "1723831050362439098", + "{\"linterDocUrl\": \"https://megalinter.io/alpha/descriptors/markdown_markdownlint\", \"jobUrl\": \"\", \"severity\": \"warning\", \"severityIcon\": \"\\u26a0\\ufe0f\", \"cliLintMode\": \"list_of_files\", \"numberFilesFound\": 264, \"numberErrorsFound\": 291, \"numberErrorsFixed\": 0, \"elapsedTime\": 30.55}" + ] + ] + } +} ``` ## Metrics Configuration diff --git a/megalinter/reporters/ApiReporter.py b/megalinter/reporters/ApiReporter.py index 2ea1daa1c00..d93d374a6a4 100644 --- a/megalinter/reporters/ApiReporter.py +++ b/megalinter/reporters/ApiReporter.py @@ -316,18 +316,18 @@ def send_to_metrics_api(self): logging.info("[Api Reporter Metrics] Using Bearer Token") try: response = session.post( - self.api_metrics_url, headers=headers, json=self.payloadFormatted + self.api_metrics_url, headers=headers, json=self.metrics_payload ) if 200 <= response.status_code < 300: logging.info( f"[Api Reporter Metrics] Successfully posted data to {self.api_metrics_url}" ) if self.is_notif_api_debug_active(): - logging.info("[Api Reporter Metrics] " + json.dumps(obj=self.payloadFormatted, indent=True)) + logging.info("[Api Reporter Metrics] " + json.dumps(obj=self.metrics_payload, indent=True)) else: logging.warning( f"[Api Reporter Metrics] Error posting data to {self.api_metrics_url} ({response.status_code})\n" - f"[Api Reporter Metrics] API request: {json.dumps(obj=self.payloadFormatted, indent=True)}\n" + f"[Api Reporter Metrics] API request: {json.dumps(obj=self.metrics_payload, indent=True)}\n" f"[Api Reporter Metrics] API response: {response.text}" ) except ConnectionError as e: