Skip to content

Commit

Permalink
Rename raw_error -> rawerror to use correct field name
Browse files Browse the repository at this point in the history
  • Loading branch information
alopezz committed Jul 21, 2023
1 parent f591625 commit 0b39351
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 15 deletions.
22 changes: 10 additions & 12 deletions datadog_checks_base/datadog_checks/base/utils/diagnose.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,7 @@ class Diagnosis:
# RawError error
# }
# defined in datadog-agent\\pkg\\diagnose\\diagnosis\\loader.go
Result = namedtuple(
'Result', ['result', 'name', 'diagnosis', 'category', 'description', 'remediation', 'raw_error']
)
Result = namedtuple('Result', ['result', 'name', 'diagnosis', 'category', 'description', 'remediation', 'rawerror'])

# defined in
# datadog-agent\\pkg\\diagnose\\diagnosis\\loader.go and
Expand All @@ -63,7 +61,7 @@ def clear(self):
"""Remove all cached diagnoses."""
self._diagnoses = []

def success(self, name, diagnosis, category=None, description=None, remediation=None, raw_error=None):
def success(self, name, diagnosis, category=None, description=None, remediation=None, rawerror=None):
"""Register a successful diagnostic result."""
self._diagnoses.append(
self._result(
Expand All @@ -73,11 +71,11 @@ def success(self, name, diagnosis, category=None, description=None, remediation=
category=category,
description=description,
remediation=remediation,
raw_error=raw_error,
rawerror=rawerror,
)
)

def fail(self, name, diagnosis, category=None, description=None, remediation=None, raw_error=None):
def fail(self, name, diagnosis, category=None, description=None, remediation=None, rawerror=None):
"""Register a failing diagnostic result."""
self._diagnoses.append(
self._result(
Expand All @@ -87,11 +85,11 @@ def fail(self, name, diagnosis, category=None, description=None, remediation=Non
category=category,
description=description,
remediation=remediation,
raw_error=raw_error,
rawerror=rawerror,
)
)

def warning(self, name, diagnosis, category=None, description=None, remediation=None, raw_error=None):
def warning(self, name, diagnosis, category=None, description=None, remediation=None, rawerror=None):
"""Register a warning for a diagnostic result."""
self._diagnoses.append(
self._result(
Expand All @@ -101,7 +99,7 @@ def warning(self, name, diagnosis, category=None, description=None, remediation=
category=category,
description=description,
remediation=remediation,
raw_error=raw_error,
rawerror=rawerror,
)
)

Expand All @@ -126,7 +124,7 @@ def run_explicit(self):
try:
diagnostic()
except Exception as e:
self._diagnoses.append(self._result(self.DIAGNOSIS_UNEXPECTED_ERROR, "", "", raw_error=str(e)))
self._diagnoses.append(self._result(self.DIAGNOSIS_UNEXPECTED_ERROR, "", "", rawerror=str(e)))

explicit_results, self._diagnoses = self._diagnoses, cached_results
return explicit_results
Expand All @@ -136,13 +134,13 @@ def diagnoses(self):
"""The list of cached diagnostics."""
return self._diagnoses

def _result(self, result, name, diagnosis, category=None, description=None, remediation=None, raw_error=None):
def _result(self, result, name, diagnosis, category=None, description=None, remediation=None, rawerror=None):
return self.Result(
result,
name,
diagnosis,
category,
self._sanitize(description),
self._sanitize(remediation),
self._sanitize(raw_error),
self._sanitize(rawerror),
)
6 changes: 3 additions & 3 deletions datadog_checks_base/tests/base/utils/test_diagnose.py
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ def bad_diagnostic(self):
"category": None,
"description": "something's wrong with your ********",
"remediation": "change your ******** to something else",
"raw_error": None,
"rawerror": None,
}

assert get_diagnoses(check) == [
Expand All @@ -153,7 +153,7 @@ def get_diagnoses(check):
return json.loads(check.get_diagnoses())


def diagnose_dict(result, name, diagnosis, category=None, description=None, remediation=None, raw_error=None):
def diagnose_dict(result, name, diagnosis, category=None, description=None, remediation=None, rawerror=None):
"""Helper function to create diagnosis result dictionaries with defaults."""
return {
"result": result,
Expand All @@ -162,5 +162,5 @@ def diagnose_dict(result, name, diagnosis, category=None, description=None, reme
"category": category,
"description": description,
"remediation": remediation,
"raw_error": raw_error,
"rawerror": rawerror,
}

0 comments on commit 0b39351

Please sign in to comment.