Package io.jenkins.plugins.onmonit

Class ONMonitConfig

java.lang.Object
hudson.model.Descriptor<GlobalConfiguration>
jenkins.model.GlobalConfiguration
io.jenkins.plugins.onmonit.ONMonitConfig
All Implemented Interfaces:
ExtensionPoint, Describable<GlobalConfiguration>, Saveable, Loadable, OnMaster
@Extension(dynamicLoadable=YES) @Symbol("onMonitConfig") public final class ONMonitConfig extends GlobalConfiguration
Global configuration for the ONMonit plug-in, as shown on the Jenkins Configure System page.

  • Field Details

  • Constructor Details

    • ONMonitConfig

      public ONMonitConfig()
      Constructor.

  • Method Details

    • get

      public static ONMonitConfig get()
      Get the current ONMonit global configuration.
      Returns:
      the ONMonit configuration, or null if Jenkins has been shut down

    • getGrafanaDashboard

      public String getGrafanaDashboard()
      Get the URL for a Grafana dashboard which can display the metrics gathered by ONMonit.
      Returns:
      the Grafana dashboard URL

    • setGrafanaDashboard

      public void setGrafanaDashboard(@CheckForNull String grafanaDashboard)
      Set the URL for a Grafana dashboard which can display the metrics gathered by ONMonit.
      Parameters:
      grafanaDashboard - the Grafana dashboard URL

    • doCheckGrafanaDashboard

      @POST public FormValidation doCheckGrafanaDashboard(@QueryParameter String grafanaDashboard) throws IOException, javax.servlet.ServletException
      Throws:
      IOException
      javax.servlet.ServletException

    • getDownloadBaseUrl

      public String getDownloadBaseUrl()
      Get the format for displaying the elapsed time.
      Returns:
      the elapsed time format

    • setDownloadBaseUrl

      public void setDownloadBaseUrl(@CheckForNull String downloadBaseUrl)
      Set a base URL from under which node_exporter and otel-contrib binaries can be downloaded.
      Parameters:
      downloadBaseUrl - the URL

    • doCheckDownloadBaseUrl

      @POST public FormValidation doCheckDownloadBaseUrl(@QueryParameter String downloadBaseUrl) throws IOException, javax.servlet.ServletException
      Throws:
      IOException
      javax.servlet.ServletException

    • getNeDefaultAdditionalOptions

      public String getNeDefaultAdditionalOptions()
      Get the default additional options for the node_exporter process.
      Returns:
      the default additional options

    • setNeDefaultAdditionalOptions

      public void setNeDefaultAdditionalOptions(@CheckForNull String defaultAdditionalOptions)
      Set the default additional options for the node_exporter process. If null, no additional options are used.
      Parameters:
      defaultAdditionalOptions - the additional options

    • getOcDefaultAdditionalOptions

      public String getOcDefaultAdditionalOptions()
      Get the default additional options for the otel-contrib process.
      Returns:
      the default additional options

    • setOcDefaultAdditionalOptions

      public void setOcDefaultAdditionalOptions(@CheckForNull String defaultAdditionalOptions)
      Set the default additional options for the otel-contrib process. If null, no additional options are used.
      Parameters:
      defaultAdditionalOptions - the additional options

    • getOtelConfigTemplate

      public String getOtelConfigTemplate()
      Get the configuration template for the otel-contrib process.
      Returns:
      the otel configuration template

    • setOtelConfigTemplate

      public void setOtelConfigTemplate(@CheckForNull String otelConfigTemplate)
      Set a configuration template for the otel-contrib process. If null, the default template from the plugin resources is used.
      Parameters:
      otelConfigTemplate - the OTEL configuration template