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

Summary

The flightRecorderEffectiveSettings() query returns the effective Java Flight Recorder (JFR) settings for a specific node. Effective settings are the cluster-wide defaults resolved with any host-specific overrides applied.

Syntax

graphql
flightRecorderEffectiveSettings(
      vhost: Int!
   ): FlightRecorderJobSettings!

The required vhost argument identifies the node by its virtual host number. The query returns a non-null FlightRecorderJobSettings! object.

Returned Values

The query returns a FlightRecorderJobSettings! object. The following table lists the available fields:

Table: FlightRecorderJobSettings Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
configurationStringyes Previewadded in 1.257Stability: Preview
enabledBooleanyes Previewadded in 1.257Stability: Preview
numberOfRecordingsIntyes Previewadded in 1.257Stability: Preview
windowDurationMinutesLongyes Previewadded in 1.257Stability: Preview