Project

General

Custom queries

Profile

Actions

User story #8584

closed

The compliance API is missing a global compliance target

Added by Matthieu CERDA almost 9 years ago. Updated about 7 years ago.

Status:
Released
Priority:
4
Category:
API
Target version:
UX impact:
Suggestion strength:
User visibility:
Effort required:
Name check:
Fix check:
Regression:

Description

I'd love to have an "/api/compliance" URL that gives the equivalent of the info we have on the dasbboard, like:
  • Global compliance
  • Compliance defails (% of success, repaired, no report, unknown, error and missing)

Moreover, we could then use this API to get the values for the dashboard when possible :)


Related issues 2 (0 open2 closed)

Related to Rudder - User story #6820: The dashboard should display something when no reporting data is available (new installation)RejectedFrançois ARMANDActions
Related to Rudder - Bug #13149: Global compliance API is not documentedReleasedBenoît PECCATTEActions
Actions #18

Updated by François ARMAND over 7 years ago

  • Status changed from In progress to Pending technical review
  • Assignee changed from François ARMAND to Vincent MEMBRÉ
  • Pull Request set to https://github.com/Normation/rudder/pull/1850
Actions #19

Updated by François ARMAND over 7 years ago

The PR add a new endpoint for "/compliance" with a return value of:

% curl -k -H "X-API-Token: ..." -H "Content-Type: application/json" -X GET 'https://.../api/latest/compliance'
{"action":"getGlobalCompliance","result":"success","data":{"globalCompliance":{"compliance":0,"complianceDetails"}}

When no non-system rules are defined, "compliane":-1 is returned without complianceDetails.

The PR also update rudder dashboard to print a message when no non-system rules are defined with a link toward rules.

Actions #22

Updated by François ARMAND over 7 years ago

  • Status changed from Pending technical review to Pending release
Actions #23

Updated by Vincent MEMBRÉ about 7 years ago

  • Status changed from Pending release to Released

This bug has been fixed in Rudder 4.3.0~rc1 which was released today.

Actions

Also available in: Atom PDF