Slzebriumexporter #2

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

b3arpsl merged 53 commits into main from slzebriumexporter

Jan 3, 2024

slzebriumexporter/Makefile

Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		include ../Makefile.Common

slzebriumexporter/README.md

-Original file line number
+Diff line change
@@ -0,0 +1,92 @@
+    # ScienceLogic Zebrium Exporter
+    | Status                   |           |
+    | ------------------------ |-----------|
+    | Stability                | [beta]    |
+    | Supported pipeline types | logs      |
+    | Distributions            | [contrib] |
+    Exports data via HTTP to Zebrium
+    ## Getting Started
+    The following settings are required:
+    - `endpoint` (no default): The target URL to send Zebrium log streams to (e.g.: `https://cloud.zebrium.com`).
+    - `ze_token` (no default): Authorization token for the Zebrium deployment
+    Optional settings:
+    - `verbosity` (default 'normal'): Use 'detailed' to log all incoming log records
+    The ScienceLogic Zebrium Exporter relies on the [ScienceLogic Log Format Processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/processor/sllogformatprocessor/README.md)
+    to populate the following attributes:
+    - `sl_metadata`: Resource attribute with encoded metadata that identifies logs from a single application instance
+    - `sl_msg`: Log record attribute with the body of the log message formated for ScienceLogic
+    - `sl_format`: Format option from the matching profile, e.g. event
+    The following example shows how to configure the format processor and exporter in a pipeline:
+    ```yaml
+    receivers:
+      windowseventlog:
+        channel: application
+        start_at: end
+    processors:
+      sllogformat:
+        send_batch_size: 10000
+        timeout: 10s
+        profiles:
+        - service_group: # windows event log
+            exp:
+              source: lit:default
+            rename: ze_deployment_name
+          host:
+            exp:
+              source: body:computer
+            rename: host
+          logbasename:
+            exp:
+              op: lc
+              exps:
+              - op: alphanum
+                exps:
+                  - op: rmprefix
+                    exps:
+                      - source: body:provider.name
+                      - source: lit:Microsoft-Windows-
+            rename: logbasename
+          message:
+            exp:
+              op: or
+              exps:
+                - source: body:message
+                - source: body:event_data
+                - source: body:keywords
+          format: event
+    exporters:
+      slzebrium:
+        verbosity: detailed
+        endpoint: https://cloud.zebrium.com
+        ze_token: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
+    service:
+      pipelines:
+        logs:
+          receivers: [windowseventlog]
+          processors: [sllogformat]
+          exporters: [slzebrium]
+    ```
+    ## Advanced Configuration
+    Several helper files are leveraged to provide additional capabilities automatically:
+    - [HTTP settings](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/confighttp/README.md)
+    - [Queuing and retry settings](https://github.com/open-telemetry/opentelemetry-collector/blob/main/exporter/exporterhelper/README.md)
+    [beta]:https://github.com/open-telemetry/opentelemetry-collector#beta
+    [contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib

slzebriumexporter/config.go

-Original file line number
+Diff line change
@@ -0,0 +1,104 @@
+    // Copyright The OpenTelemetry Authors
+    //
+    // Licensed under the Apache License, Version 2.0 (the "License");
+    // you may not use this file except in compliance with the License.
+    // You may obtain a copy of the License at
+    //
+    //       http://www.apache.org/licenses/LICENSE-2.0
+    //
+    // Unless required by applicable law or agreed to in writing, software
+    // distributed under the License is distributed on an "AS IS" BASIS,
+    // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    // See the License for the specific language governing permissions and
+    // limitations under the License.
+    package slzebriumexporter // import "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/slzebriumexporter"
+    import (
+    	"encoding/hex"
+    	"errors"
+    	"fmt"
+    	"net/url"
+    	"go.uber.org/zap/zapcore"
+    	"go.opentelemetry.io/collector/component"
+    	"go.opentelemetry.io/collector/config/confighttp"
+    	"go.opentelemetry.io/collector/config/configtelemetry"
+    	"go.opentelemetry.io/collector/confmap"
+    	"go.opentelemetry.io/collector/exporter/exporterhelper"
+    )
+    var (
+    	// supportedLevels in this exporter's configuration.
+    	// configtelemetry.LevelNone and other future values are not supported.
+    	supportedLevels map[configtelemetry.Level]struct{} = map[configtelemetry.Level]struct{}{
+    		configtelemetry.LevelBasic:    {},
+    		configtelemetry.LevelNormal:   {},
+    		configtelemetry.LevelDetailed: {},
+    	}
+    )
+    // Config defines configuration for slzebrium exporter.
+    type Config struct {
+    	confighttp.HTTPClientSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct.
+    	exporterhelper.QueueSettings  `mapstructure:"sending_queue"`
+    	exporterhelper.RetrySettings  `mapstructure:"retry_on_failure"`
+    	// Verbosity defines the zebrium exporter verbosity.
+    	Verbosity configtelemetry.Level `mapstructure:"verbosity"`
+    	// ZeUrl Zebrium ZAPI authentication token
+    	ZeToken string `mapstructure:"ze_token"`
+    }
+    var _ component.Config = (*Config)(nil)
+    var _ confmap.Unmarshaler = (*Config)(nil)
+    func mapLevel(level zapcore.Level) (configtelemetry.Level, error) {
+    	switch level {
+    	case zapcore.DebugLevel:
+    		return configtelemetry.LevelDetailed, nil
+    	case zapcore.InfoLevel:
+    		return configtelemetry.LevelNormal, nil
+    	case zapcore.WarnLevel, zapcore.ErrorLevel,
+    		zapcore.DPanicLevel, zapcore.PanicLevel, zapcore.FatalLevel:
+    		// Anything above info is mapped to 'basic' level.
+    		return configtelemetry.LevelBasic, nil
+    	default:
+    		return configtelemetry.LevelNone, fmt.Errorf("log level %q is not supported", level)
+    	}
+    }
+    func (cfg *Config) Unmarshal(conf *confmap.Conf) error {
+    	if err := conf.Unmarshal(cfg, confmap.WithErrorUnused()); err != nil {
+    		return err
+    	}
+    	return nil
+    }
+    func validateZeToken(token string) error {
+    	if len(token) != 40 {
+    		return errors.New("must be 40 hex characters")
+    	}
+    	dst := make([]byte, hex.DecodedLen(len(token)))
+    	_, err := hex.Decode(dst, []byte(token))
+    	return err
+    }
+    // Validate checks if the exporter configuration is valid
+    func (cfg *Config) Validate() error {
+    	if err := cfg.QueueSettings.Validate(); err != nil {
+    		return fmt.Errorf("queue settings has invalid configuration: %w", err)
+    	}
+    	if _, err := url.ParseRequestURI(cfg.Endpoint); cfg.Endpoint == "" || err != nil {
+    		return fmt.Errorf("\"endpoint\" must be a valid URL")
+    	}
+    	if _, ok := supportedLevels[cfg.Verbosity]; !ok {
+    		return fmt.Errorf("verbosity level %q is not supported", cfg.Verbosity)
+    	}
+    	if err := validateZeToken(cfg.ZeToken); err != nil {
+    		return fmt.Errorf("ze_token invalid: %s", err.Error())
+    	}
+    	return nil
+    }

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Slzebriumexporter #2

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!