- 
          
- 
                Notifications
    You must be signed in to change notification settings 
- Fork 13
docs: Add telemetry documentation page #731
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
          
     Merged
      
      
    
  
     Merged
                    Changes from all commits
      Commits
    
    
            Show all changes
          
          
            14 commits
          
        
        Select commit
          Hold shift + click to select a range
      
      8869849
              
                docs: Add initial telemetry docs
              
              
                Techassi 2bfb490
              
                docs: Use code callouts
              
              
                Techassi 4a15d1a
              
                docs: Add section for file logs
              
              
                Techassi 75cf3d7
              
                docs: Add OpenTelemetry logs and traces section
              
              
                Techassi f805ace
              
                docs: Add admonition about default and supported values
              
              
                Techassi e230821
              
                docs: Add operator default values
              
              
                Techassi 732e062
              
                docs: Adjust available signals section
              
              
                Techassi e3fc6e8
              
                docs: Remove metrics signal
              
              
                Techassi 4da9817
              
                chore: Apply suggestion
              
              
                Techassi 62bd563
              
                docs: Adjust note about operator defaults
              
              
                Techassi 7103abc
              
                chore: Apply suggestion
              
              
                Techassi 8127c96
              
                chore: Merge branch 'main' into docs/telemetry
              
              
                Techassi 54a6ba0
              
                chore: Merge branch 'main' into docs/telemetry
              
              
                Techassi 5b57be3
              
                chore: Merge branch 'main' into docs/telemetry
              
              
                Techassi File filter
Filter by extension
Conversations
          Failed to load comments.   
        
        
          
      Loading
        
  Jump to
        
          Jump to file
        
      
      
          Failed to load files.   
        
        
          
      Loading
        
  Diff view
Diff view
There are no files selected for viewing
  
    
      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
    
  
  
    
              
              
  
    
      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
    
  
  
    
              | Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| = Telemetry signals in operators | ||
|         
                  Techassi marked this conversation as resolved.
              Show resolved
            Hide resolved | ||
|  | ||
| Since SDP 25.7.0, all Stackable operators emit telemetry data in the following ways: | ||
|         
                  Techassi marked this conversation as resolved.
              Show resolved
            Hide resolved | ||
|  | ||
| * Console logs in plain and JSON format | ||
| * File logs in JSON format (with the option of Rolling files) | ||
| * OpenTelemetry logs exported via OTLP | ||
| * OpenTelemetry traces exported via OTLP | ||
|  | ||
| Every subscriber can be toggled and customized using Helm values. | ||
|         
                  Techassi marked this conversation as resolved.
              Show resolved
            Hide resolved | ||
| All fields are grouped under the top-level `telemetry` section. | ||
|  | ||
| [NOTE] | ||
| ==== | ||
| The following sections describe the available fields as well as their default and supported values. | ||
| If the Helm values explained below are not overridden, the following operator defaults apply: | ||
|  | ||
| * Levels for all signals are set to `INFO`. | ||
| * Console logs are enabled | ||
| * File logs are disabled | ||
| * File logs rotation period is set to `Never` | ||
| * File logs max files is unset | ||
| * OpenTelemetry logs and traces are disabled | ||
| * OTLP endpoints are set to `http://localhost:4317` | ||
| ==== | ||
|  | ||
| == Console logs | ||
|  | ||
| This signal prints log messages at the selected level and in the selected format to STDOUT. | ||
| These logs are useful for quick debugging. | ||
| For a more complete debugging experience, we recommend the OpenTelemetry signals. | ||
|  | ||
| [source,yaml] | ||
| ---- | ||
| telemetry: | ||
| consoleLog: | ||
| enabled: true # <1> | ||
| level: null # <2> | ||
| format: null # <3> | ||
| ---- | ||
|  | ||
| <1> Boolean: `true, false` | ||
| <2> Enum: `error, warning, info, debug, trace` | ||
| <3> Enum: `plain, json` | ||
|         
                  Techassi marked this conversation as resolved.
              Show resolved
            Hide resolved | ||
|  | ||
| == File logs | ||
|  | ||
| This signal writes log messages at the selected level in JSON to (rolling) log file(s). | ||
| These logs can be picked up by a log aggregation system, like Vector. | ||
|  | ||
| [source,yaml] | ||
| ---- | ||
| telemetry: | ||
| fileLog: | ||
| enabled: false # <1> | ||
| level: null # <2> | ||
|         
                  Techassi marked this conversation as resolved.
              Show resolved
            Hide resolved | ||
| rotationPeriod: hourly # <3> | ||
| maxFiles: 6 # <4> | ||
| ---- | ||
|  | ||
| <1> Boolean: `true, false` | ||
| <2> Enum: `error, warning, info, debug, trace` | ||
| <3> Enum: `never, daily, hourly, minutely` | ||
| <4> Unsigned Integer | ||
|  | ||
| == OpenTelemetry logs and traces | ||
|  | ||
| These two signal export OpenTelemetry logs and traces to OTLP enabled collectors. | ||
| These signals can be visualized using tools, like Grafana, Loki, and Jaeger. | ||
|  | ||
| [source,yaml] | ||
| ---- | ||
| telemetry: | ||
| otelLogExporter: | ||
| enabled: false # <1> | ||
| level: null # <2> | ||
| endpoint: null # <3> | ||
| otelTraceExporter: | ||
| enabled: false # <1> | ||
| level: null # <2> | ||
| endpoint: null # <3> | ||
| ---- | ||
|  | ||
| <1> Boolean: `true, false` | ||
| <2> Enum: `error, warning, info, debug, trace` | ||
| <3> String: E.g. `my-collector:4317` | ||
      
      Oops, something went wrong.
        
    
  
  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.
  
    
  
    
Uh oh!
There was an error while loading. Please reload this page.