🎯API Stability
PreviewThis API is under active development and may change significantly. Not recommended for production use.

Summary

The updateFlightRecorderClusterSettings() mutation updates cluster-wide Java Flight Recorder (JFR) settings. Only fields present in the input are changed; omitted fields retain their current values.

Syntax

graphql
updateFlightRecorderClusterSettings(
      input: UpdateFlightRecorderClusterSettingsInput!
   ): Boolean!

The mutation accepts an UpdateFlightRecorderClusterSettingsInput input object and returns a Boolean! indicating whether the update was successful.

Input Parameters

The mutation accepts a single UpdateFlightRecorderClusterSettingsInput input object. The following table describes the available fields:

Table: UpdateFlightRecorderClusterSettingsInput Input

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
configurationNameString   added in 1.257Predefined JFR configuration name (e.g. 'default', 'profile'). Mutually exclusive with configurationXml.
configurationXmlString   added in 1.257Raw JFR XML configuration content. Mutually exclusive with configurationName. Max 64KB.
enabledBoolean   added in 1.257Whether recording is enabled cluster-wide
numberOfRecordingsInt   added in 1.257Maximum number of rolling recording files to keep
resetToDefaultsBoolean   added in 1.257If true, reset all cluster settings to defaults (other fields ignored)
windowDurationMinutesLong   added in 1.257Recording window duration in minutes