Package com.vaadin.observability.spring.boot

Class ObservabilityProperties

java.lang.Object
com.vaadin.observability.spring.boot.ObservabilityProperties
@ConfigurationProperties(prefix="vaadin.observability") public class ObservabilityProperties extends Object
Boot-bound configuration properties under the vaadin.observability prefix. Converted to a plain ObservabilitySettings via toSettings().

  • Constructor Details

    • ObservabilityProperties

      public ObservabilityProperties()

  • Method Details

    • isEnabled

      public boolean isEnabled()

    • setEnabled

      public void setEnabled(boolean enabled)

    • isSessions

      public boolean isSessions()

    • setSessions

      public void setSessions(boolean sessions)

    • isUis

      public boolean isUis()

    • setUis

      public void setUis(boolean uis)

    • isUiState

      public boolean isUiState()

    • setUiState

      public void setUiState(boolean uiState)

    • isNavigation

      public boolean isNavigation()

    • setNavigation

      public void setNavigation(boolean navigation)

    • isRequests

      public boolean isRequests()

    • setRequests

      public void setRequests(boolean requests)

    • isErrors

      public boolean isErrors()

    • setErrors

      public void setErrors(boolean errors)

    • isClient

      public boolean isClient()

    • setClient

      public void setClient(boolean client)

    • isResync

      public boolean isResync()

    • setResync

      public void setResync(boolean resync)

    • isTraces

      public boolean isTraces()

    • setTraces

      public void setTraces(boolean traces)

    • isTracesSessionId

      public boolean isTracesSessionId()

    • setTracesSessionId

      public void setTracesSessionId(boolean tracesSessionId)

    • isInsights

      public boolean isInsights()
      Whether failed and over-budget user interactions are retained so the insights endpoint can backtrack a user report to a replicable interaction. Enabled by default.

      Independent of isInsightsDetails(), which governs only how much detail a retained interaction carries.

    • setInsights

      public void setInsights(boolean insights)

    • isData

      public boolean isData()
      Whether the data provider queries made by lazy-loading components are measured. On by default.
      Returns:
      true if data query metrics are recorded

    • setData

      public void setData(boolean data)
      Sets whether data provider queries are measured.
      Parameters:
      data - true to record data query metrics

    • isInsightsDetails

      public boolean isInsightsDetails()
      Whether interaction insights may carry potentially sensitive detail: the raw session id, the exception message and the top stack frames. Off by default, since the insights payload is meant to be forwarded.

    • setInsightsDetails

      public void setInsightsDetails(boolean insightsDetails)

    • isDatabase

      public boolean isDatabase()

    • setDatabase

      public void setDatabase(boolean database)

    • isDatabaseStatement

      public boolean isDatabaseStatement()

    • setDatabaseStatement

      public void setDatabaseStatement(boolean databaseStatement)

    • getRouteCardinalityLimit

      public int getRouteCardinalityLimit()

    • setRouteCardinalityLimit

      public void setRouteCardinalityLimit(int routeCardinalityLimit)

    • getClientRatePerSession

      public int getClientRatePerSession()

    • setClientRatePerSession

      public void setClientRatePerSession(int clientRatePerSession)

    • getUiStateSampleInterval

      public int getUiStateSampleInterval()

    • setUiStateSampleInterval

      public void setUiStateSampleInterval(int uiStateSampleInterval)

    • getUiStateBytesPerNode

      public int getUiStateBytesPerNode()

    • setUiStateBytesPerNode

      public void setUiStateBytesPerNode(int uiStateBytesPerNode)

    • getUiStateGrowthSamples

      public int getUiStateGrowthSamples()
      Measurements a view collection has to grow in before it is reported as growing; 0 does not read view collections at all.
      Returns:
      the number of measurements, or 0

    • setUiStateGrowthSamples

      public void setUiStateGrowthSamples(int uiStateGrowthSamples)

    • getInsightsCapacity

      public int getInsightsCapacity()
      Maximum number of records retained for the insights endpoint, applied to each buffer rather than shared: interactions and data provider queries are retained separately, so with both active the total is twice this.
      Returns:
      the per-buffer capacity

    • setInsightsCapacity

      public void setInsightsCapacity(int insightsCapacity)

    • toSettings

      public ObservabilitySettings toSettings()