-
Notifications
You must be signed in to change notification settings - Fork 1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[BACKPORT 2.18.5][PLAT-10616] Support SpecificGflags in audit
Summary: Original commit: b826052/D29248 Added support for SpecificGflags in gflags audit. Also covered the case, when read replica has overriden gflags. In that case audit will contain "readonly_cluster_gflags" field, for example: ``` { "gflags": { "master": [ { "name": "master", "old": "1", "new": "2", "default": "master" } ], "tserver": [ { "name": "tserver", "old": "1", "new": "3", "default": "tserver" } ] }, "readonly_cluster_gflags": { "master": [ { "name": "master", "old": "5", "new": "1", "default": "master" } ], "tserver": [ { "name": "tserver2", "old": "2", "new": null, "default": "tserver2" }, { "name": "tserver", "old": null, "new": "2", "default": "tserver" } ] } } ``` Test Plan: sbt test Manual testing: Run gflags upgrade on universe and verify audit data Reviewers: #yba-api-review, cwang, anijhawan, yshchetinin Reviewed By: #yba-api-review, cwang, anijhawan Subscribers: dshubin, yugaware Tags: #jenkins-ready Differential Revision: https://phorge.dev.yugabyte.com/D31063
- Loading branch information
Showing
6 changed files
with
327 additions
and
98 deletions.
There are no files selected for viewing
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
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
135 changes: 135 additions & 0 deletions
135
managed/src/main/java/com/yugabyte/yw/controllers/handlers/GFlagsAuditHandler.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| // Copyright (c) YugaByte, Inc. | ||
|
|
||
| package com.yugabyte.yw.controllers.handlers; | ||
|
|
||
| import com.fasterxml.jackson.databind.JsonNode; | ||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
| import com.google.common.collect.Sets; | ||
| import com.yugabyte.yw.commissioner.tasks.UniverseTaskBase; | ||
| import com.yugabyte.yw.common.PlatformServiceException; | ||
| import com.yugabyte.yw.common.gflags.GFlagDetails; | ||
| import com.yugabyte.yw.common.gflags.GFlagDiffEntry; | ||
| import com.yugabyte.yw.common.gflags.GFlagsAuditPayload; | ||
| import com.yugabyte.yw.common.gflags.GFlagsUtil; | ||
| import com.yugabyte.yw.forms.GFlagsUpgradeParams; | ||
| import com.yugabyte.yw.forms.UniverseDefinitionTaskParams; | ||
| import com.yugabyte.yw.models.Universe; | ||
| import java.io.IOException; | ||
| import java.util.ArrayList; | ||
| import java.util.Collection; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Objects; | ||
| import java.util.UUID; | ||
| import java.util.stream.Collectors; | ||
| import javax.inject.Inject; | ||
| import javax.inject.Singleton; | ||
| import lombok.extern.slf4j.Slf4j; | ||
|
|
||
| @Singleton | ||
| @Slf4j | ||
| public class GFlagsAuditHandler { | ||
|
|
||
| private final GFlagsValidationHandler gFlagsValidationHandler; | ||
|
|
||
| @Inject | ||
| public GFlagsAuditHandler(GFlagsValidationHandler gFlagsValidationHandler) { | ||
| this.gFlagsValidationHandler = gFlagsValidationHandler; | ||
| } | ||
|
|
||
| public JsonNode constructGFlagAuditPayload(GFlagsUpgradeParams requestParams) { | ||
| Universe universe = Universe.getOrBadRequest(requestParams.getUniverseUUID()); | ||
| Map<UUID, UniverseDefinitionTaskParams.Cluster> newVersionsOfClusters = | ||
| requestParams.getNewVersionsOfClusters(universe); | ||
| Map<UUID, UniverseDefinitionTaskParams.Cluster> oldVersionsOfClusters = | ||
| universe.getUniverseDetails().clusters.stream() | ||
| .collect(Collectors.toMap(c -> c.uuid, c -> c)); | ||
| String softwareVersion = requestParams.getPrimaryCluster().userIntent.ybSoftwareVersion; | ||
|
|
||
| Map<String, GFlagsAuditPayload> auditPayload = new HashMap<>(); | ||
|
|
||
| for (UniverseDefinitionTaskParams.Cluster newCluster : newVersionsOfClusters.values()) { | ||
| Map<String, String> newMasterGFlags = | ||
| GFlagsUtil.getBaseGFlags( | ||
| UniverseTaskBase.ServerType.MASTER, newCluster, newVersionsOfClusters.values()); | ||
| Map<String, String> newTserverGFlags = | ||
| GFlagsUtil.getBaseGFlags( | ||
| UniverseTaskBase.ServerType.TSERVER, newCluster, newVersionsOfClusters.values()); | ||
| UniverseDefinitionTaskParams.Cluster oldCluster = oldVersionsOfClusters.get(newCluster.uuid); | ||
| Map<String, String> oldMasterGFlags = | ||
| GFlagsUtil.getBaseGFlags( | ||
| UniverseTaskBase.ServerType.MASTER, oldCluster, oldVersionsOfClusters.values()); | ||
| Map<String, String> oldTserverGFlags = | ||
| GFlagsUtil.getBaseGFlags( | ||
| UniverseTaskBase.ServerType.TSERVER, oldCluster, oldVersionsOfClusters.values()); | ||
| if (!Objects.equals(newMasterGFlags, oldMasterGFlags) | ||
| || !Objects.equals(newTserverGFlags, oldTserverGFlags)) { | ||
| GFlagsAuditPayload payload = new GFlagsAuditPayload(); | ||
|
|
||
| payload.master = | ||
| generateGFlagEntries( | ||
| oldMasterGFlags, | ||
| newMasterGFlags, | ||
| UniverseTaskBase.ServerType.MASTER.toString(), | ||
| softwareVersion); | ||
| payload.tserver = | ||
| generateGFlagEntries( | ||
| oldTserverGFlags, | ||
| newTserverGFlags, | ||
| UniverseTaskBase.ServerType.TSERVER.toString(), | ||
| softwareVersion); | ||
|
|
||
| if (newCluster.clusterType == UniverseDefinitionTaskParams.ClusterType.PRIMARY) { | ||
| auditPayload.put("gflags", payload); | ||
| } else if (!GFlagsUtil.areGflagsInheritedFromPrimary(newCluster) | ||
| || !GFlagsUtil.areGflagsInheritedFromPrimary(oldCluster)) { | ||
| auditPayload.put("readonly_cluster_gflags", payload); | ||
| } | ||
| } | ||
| } | ||
| ObjectMapper mapper = new ObjectMapper(); | ||
| return mapper.valueToTree(auditPayload); | ||
| } | ||
|
|
||
| public List<GFlagDiffEntry> generateGFlagEntries( | ||
| Map<String, String> oldGFlags, | ||
| Map<String, String> newGFlags, | ||
| String serverType, | ||
| String softwareVersion) { | ||
| List<GFlagDiffEntry> gFlagChanges = new ArrayList<>(); | ||
| if (oldGFlags == null) { | ||
| oldGFlags = new HashMap<>(); | ||
| } | ||
| if (newGFlags == null) { | ||
| newGFlags = new HashMap<>(); | ||
| } | ||
| GFlagDiffEntry tEntry; | ||
| Collection<String> modifiedGFlags = Sets.union(oldGFlags.keySet(), newGFlags.keySet()); | ||
|
|
||
| for (String gFlagName : modifiedGFlags) { | ||
| String oldGFlagValue = oldGFlags.getOrDefault(gFlagName, null); | ||
| String newGFlagValue = newGFlags.getOrDefault(gFlagName, null); | ||
| if (oldGFlagValue == null || !oldGFlagValue.equals(newGFlagValue)) { | ||
| String defaultGFlagValue = getGFlagDefaultValue(softwareVersion, serverType, gFlagName); | ||
| tEntry = new GFlagDiffEntry(gFlagName, oldGFlagValue, newGFlagValue, defaultGFlagValue); | ||
| gFlagChanges.add(tEntry); | ||
| } | ||
| } | ||
|
|
||
| return gFlagChanges; | ||
| } | ||
|
|
||
| private String getGFlagDefaultValue(String softwareVersion, String serverType, String gFlagName) { | ||
| GFlagDetails defaultGFlag; | ||
| String defaultGFlagValue; | ||
| try { | ||
| defaultGFlag = | ||
| gFlagsValidationHandler.getGFlagsMetadata(softwareVersion, serverType, gFlagName); | ||
| } catch (IOException | PlatformServiceException e) { | ||
| defaultGFlag = null; | ||
| } | ||
| defaultGFlagValue = (defaultGFlag == null) ? null : defaultGFlag.defaultValue; | ||
| return defaultGFlagValue; | ||
| } | ||
| } |
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
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
Oops, something went wrong.