plugin_name: go.d.plugin
modules:
  - meta:
      id: collector-go.d.plugin-litespeed
      plugin_name: go.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: [Linux, BSD]
        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: go.d/litespeed.conf
        options:
          description: |
            The following options can be defined globally: update_every, autodetection_retry.
          folding:
            title: Config options
            enabled: true
          list:
            - name: update_every
              description: Data collection frequency.
              default_value: 10
              required: false
            - name: autodetection_retry
              description: Sets the job re-check interval in seconds.
              default_value: 0
              required: false
            - name: reports_dir
              description: Directory containing Litespeed's real-time statistics files.
              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: |
                local:
                 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.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.net_throughput
              description: Network Throughput HTTP
              unit: "kilobits/s"
              chart_type: area
              dimensions:
                - name: in
                - name: out
            - name: litespeed.net_ssl_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.ssl_connections
              description: Connections HTTPS
              unit: "conns"
              chart_type: stacked
              dimensions:
                - name: free
                - name: used
            - name: litespeed.public_cache
              description: Public Cache Hits
              unit: "hits/s"
              chart_type: line
              dimensions:
                - name: hits
            - name: litespeed.private_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
