Overwriting the Diagnostics Configuration
search cancel

Overwriting the Diagnostics Configuration

book

Article ID: 369791

calendar_today

Updated On:

Products

VMware Aria Suite

Issue/Introduction

By using a JSON solution config file, you can manage some parameters of VCF Diagnostics, such as deactivating rules or setting defaults for some tasks, depending on your environment. You can create such a file by navigating to Operations > Configurations > Management Packs Configuration > Add:

File Name: diagnostics_mp_config_overwrites.json

Free format: yes

Content example:

{

"disabledRuleIds": ["RULE_ID”]

}

 

You take the RULE_ID parameter from the list of Diagnostics rules in the Findings Catalog on the Diagnostic Findings tab on VCF Operations. You can add multiple parameters, separated by a comma.


See the full list of possible parameters fields with example values:

{

    "disabledRuleIds": ["AUTOMATION_datarecordsleak_KB_93133"],

  "maxObjectsCount": 1000000,

    "parallelRuleExecutionCount": 10,

    "findingsLimitForRule": 500,

    "queryTimeoutInMins": 3,

    "activeScanDurationInHrs": 24,

    "historicalScanMaxDurationInDays": 7,

    "activeScanRetentionInHrs": 36,

    "historicalScanRetentionInHrs": 96,

    "workloadProvisioningRetentionInHrs": 168,

    "snapshotProvisioningRetentionInHrs": 168

}

The set parameters take effect in Diagnostics findings calculations in up to 4 hours.

Resolution

The two most common cases when you would need a JSON solution config file to overwrite the Diagnostics configuration are the following:

 

  1.     Consider sizing limits for your environment:
    Best practice is to segregate workloads to optimize performance and computation time of VCF Diagnostics. This means dividing an environment by some logical grouping, such as by geography or business function for example, to avoid excessive use of resources for the Diagnostics collector if you use the whole stack. Part of this strategy is the ability to manage the limit of the number of objects that are part of such workloads and setting up a cloud proxy for each workload. You see an alert for the threshold of the max object count that you must consider when segregating workloads, which gives you a decision point whether to segregate workloads or increase the limit if this makes sense for your setup.

    Example:
    {
        "disabledRuleIds":
        [
            "RULE_ID1"
        ],
        "maxObjectsCount": 1000000
    }

 

  1.  
    Deactivate a Diagnostics finding from being calculated:

In the rare case that a Diagnostic finding doesn’t produce adequate or wrong output, you can deactivate the Diagnostic rule.

 

Example:

Contents example:

{

    "disabledRuleIds": ["NSXT_TrimmedException_KB_92309", “AUTOMATION_datarecordsleak_KB_93133”]

}