plugin_name: python.d.plugin
modules:
  - meta:
      plugin_name: python.d.plugin
      module_name: litespeed
      monitored_instance:
        name: Litespeed
        link: "https://www.litespeedtech.com/products/litespeed-web-server"
        categories:
          - data-collection.web-servers-and-web-proxies
        icon_filename: "litespeed.svg"
      related_resources:
        integrations:
          list: []
      info_provided_to_referring_integrations:
        description: ""
      keywords:
        - litespeed
        - web
        - server
      most_popular: false
    overview:
      data_collection:
        metrics_description: "Examine Litespeed metrics for insights into web server operations. Analyze request rates, response times, and error rates for efficient web service delivery."
        method_description: "The collector uses the statistics under /tmp/lshttpd to gather the metrics."
      supported_platforms:
        include: []
        exclude: []
      multi_instance: false
      additional_permissions:
        description: ""
      default_behavior:
        auto_detection:
          description: "If no configuration is present, the collector will attempt to read files under /tmp/lshttpd/."
        limits:
          description: ""
        performance_impact:
          description: ""
    setup:
      prerequisites:
        list: []
      configuration:
        file:
          name: python.d/litespeed.conf
        options:
          description: |
            There are 2 sections:
            
            * Global variables
            * One or more JOBS that can define multiple different instances to monitor.
            
            The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
            
            Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
            
            Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
          folding:
            title: "Config options"
            enabled: true
          list:
            - name: update_every
              description: Sets the default data collection frequency.
              default_value: 5
              required: false
            - name: priority
              description: Controls the order of charts at the netdata dashboard.
              default_value: 60000
              required: false
            - name: autodetection_retry
              description: Sets the job re-check interval in seconds.
              default_value: 0
              required: false
            - name: penalty
              description: Indicates whether to apply penalty to update_every in case of failures.
              default_value: yes
              required: false
            - name: name
              description: Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed running at any time. This allows autodetection to try several alternatives and pick the one that works.
              default_value: ""
              required: false
            - name: path
              description: Use a different path than the default, where the lightspeed stats files reside.
              default_value: "/tmp/lshttpd/"
              required: false
        examples:
          folding:
            enabled: false
            title: "Config"
          list:
            - name: Set the path to statistics
              description: Change the path for the litespeed stats files
              config: |
                localhost:
                 name: 'local'
                 path: '/tmp/lshttpd'
    troubleshooting:
      problems:
        list: []
    alerts: []
    metrics:
      folding:
        title: Metrics
        enabled: false
      description: ""
      availability: []
      scopes:
        - name: global
          description: "These metrics refer to the entire monitored application."
          labels: []
          metrics:
            - name: litespeed.net_throughput
              description: Network Throughput HTTP
              unit: "kilobits/s"
              chart_type: area
              dimensions:
                - name: in
                - name: out
            - name: litespeed.net_throughput
              description: Network Throughput HTTPS
              unit: "kilobits/s"
              chart_type: area
              dimensions:
                - name: in
                - name: out
            - name: litespeed.connections
              description: Connections HTTP
              unit: "conns"
              chart_type: stacked
              dimensions:
                - name: free
                - name: used
            - name: litespeed.connections
              description: Connections HTTPS
              unit: "conns"
              chart_type: stacked
              dimensions:
                - name: free
                - name: used
            - name: litespeed.requests
              description: Requests
              unit: "requests/s"
              chart_type: line
              dimensions:
                - name: requests
            - name: litespeed.requests_processing
              description: Requests In Processing
              unit: "requests"
              chart_type: line
              dimensions:
                - name: processing
            - name: litespeed.cache
              description: Public Cache Hits
              unit: "hits/s"
              chart_type: line
              dimensions:
                - name: hits
            - name: litespeed.cache
              description: Private Cache Hits
              unit: "hits/s"
              chart_type: line
              dimensions:
                - name: hits
            - name: litespeed.static
              description: Static Hits
              unit: "hits/s"
              chart_type: line
              dimensions:
                - name: hits