- 
                Notifications
    You must be signed in to change notification settings 
- Fork 807
Add support for opensearch searchable snapshot metrics #860
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
          
     Open
      
      
            etgraylog
  wants to merge
  13
  commits into
  prometheus-community:master
  
    
      
        
          
  
    
      Choose a base branch
      
     
    
      
        
      
      
        
          
          
        
        
          
            
              
              
              
  
           
        
        
          
            
              
              
           
        
       
     
  
        
          
            
          
            
          
        
       
    
      
from
etgraylog:add-opensearch-searchable-snapshot-filecache
  
      
      
   
  
    
  
  
  
 
  
      
    base: master
Could not load branches
            
              
  
    Branch not found: {{ refName }}
  
            
                
      Loading
              
            Could not load tags
            
            
              Nothing to show
            
              
  
            
                
      Loading
              
            Are you sure you want to change the base?
            Some commits from the old base branch may be removed from the timeline,
            and old review comments may become outdated.
          
          
                
     Open
            
            Add support for opensearch searchable snapshot metrics #860
                    etgraylog
  wants to merge
  13
  commits into
  prometheus-community:master
from
etgraylog:add-opensearch-searchable-snapshot-filecache
  
      
      
   
              
            Conversation
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
    Signed-off-by: etgraylog <[email protected]>
Signed-off-by: etgraylog <[email protected]>
Signed-off-by: etgraylog <[email protected]>
…trics Signed-off-by: etgraylog <[email protected]>
Signed-off-by: etgraylog <[email protected]>
Signed-off-by: etgraylog <[email protected]>
Signed-off-by: etgraylog <[email protected]>
Signed-off-by: etgraylog <[email protected]>
Signed-off-by: etgraylog <[email protected]>
Signed-off-by: etgraylog <[email protected]>
Signed-off-by: etgraylog <[email protected]>
Signed-off-by: etgraylog <[email protected]>
e80b455    to
    10c519a      
    Compare
  
    | @sysadmind is there anything missing in this PR to review and merge it? | 
Signed-off-by: Evan Tepsic <[email protected]>
  
    Sign up for free
    to join this conversation on GitHub.
    Already have an account?
    Sign in to comment
  
      
  Add this suggestion to a batch that can be applied as a single commit.
  This suggestion is invalid because no changes were made to the code.
  Suggestions cannot be applied while the pull request is closed.
  Suggestions cannot be applied while viewing a subset of changes.
  Only one suggestion per line can be applied in a batch.
  Add this suggestion to a batch that can be applied as a single commit.
  Applying suggestions on deleted lines is not supported.
  You must change the existing code in this line in order to create a valid suggestion.
  Outdated suggestions cannot be applied.
  This suggestion has been applied or marked resolved.
  Suggestions cannot be applied from pending reviews.
  Suggestions cannot be applied on multi-line comments.
  Suggestions cannot be applied while the pull request is queued to merge.
  Suggestion cannot be applied right now. Please check back later.
  
    
  
    
Description
Elasticsearch & Opensearch both have a Searchable Snapshots feature that emit metrics from unique API endpoints:
The Elasticsearch Searchable Snapshots metrics appear to be available via the
es.snapshotsargument, while there does not yet appear to be a similar argument for Opensearch Searchable Snapshot metrics.A minimal amount of changes were realized to add support for these metrics, leveraging existing structs & other data types with a new node role while adding necessary elements to for example
nodeMetrics(collector/nodes.go).Motivation and Context
The motivation of this PR is to add support for Opensearch Searchable Snapshots to the
elasticsearch_exporterso that they can be scraped by Prometheus for monitoring & serviceability.Several modifications have been made in a fork to quickly add support for these. A better way to emit these more than likely exists so that for example only nodes with
es_search_node=truewould be collected. Moreover, adding a CLI argument to enable these metrics as they are not applicable to Elasticsearch. The changes in this PR could be a decent starting place however if not at least found useful by others.Details
The proposed changes add 8x new metrics to the collection from the Opensearch Nodes API: