Uploaded image for project: 'Red Hat Advanced Cluster Management'
  1. Red Hat Advanced Cluster Management
  2. ACM-4702

Documentation for Search metrics

XMLWordPrintable

    • False
    • None
    • False
    • ACM-59 - Drive cloud services investment from telemetry data
    • No

      Create an informative issue (See each section, incomplete templates/issues won't be triaged)

      Using the current documentation as a model, please complete the issue template. 

      Note: Doc team updates the current version and the two previous versions (n-2). For earlier versions, we will address only high-priority, customer-reported issues for releases in support.

      Prerequisite: Start with what we have

      Always look at the current documentation to describe the change that is needed. Use the source or portal link for Step 4:

       - Use the Customer Portal: https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes

       - Use the GitHub link to find the staged docs in the repository: https://github.com/stolostron/rhacm-docs 

      Describe the changes in the doc and link to your dev story

      Provide info for the following steps:

      1. - [X] Mandatory Add the required version to the Fix version/s field.

             ACM 2.8 

      2. - [X] Mandatory Choose the type of documentation change.

            - [x] New topic in an existing section or new section
            - [ ] Update to an existing topic

      3. - [X] Mandatory for GA content:
                  
             - [X] Add steps and/or other important conceptual information here: 

             Search-v2-API and Search-Indexer now expose usage metrics and can be viewed via the metrics view in OCP console. We should provide documentation to explain these metrics so that users are aware. 

      Provide metrics and definitions (metrics are defined as histograms, gauges, summaries or counter)

      Search-v2-api:

      Histograms:

      • search_api_requests - Histogram of HTTP requests duration (seconds).
      • search_dbquery_duration_seconds - Latency of DB requests in seconds.

      Counters:

      • search_api_db_connection_failed_total - The total number of DB connection that has failed

      Search-indexer:

      Histograms:

      • search_indexer_request_duration - Time (seconds) the search indexer takes to process a request (from managed cluster).
      • search_indexer_request_size - Total changes (add, update, delete) in the search indexer request (from managed cluster).

      Counters:

      • search_indexer_request_count - Total requests received by the search indexer (from managed clusters).

      Gauges:

      • search_indexer_requests_in_flight - Total requests the search indexer is processing at a given time.

      The user can access these metrics from the console via Metrics page. See attached screenshots.

             - [ ] Add Required access level for the user to complete the task here:       

             - [ ] Add verification at the end of the task, how does the user verify success (a command to run or a result to see?)
             - [ ] Add link to dev story here:

      4. - [ ] Mandatory for bugs: What is the diff? Clearly define what the problem is, what the change is, and link to the current documentation:

            mdockery@redhat.com Mikela Jackson
            acoba@redhat.com Anxhela Coba
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: