osqueryreceiver

package module
v0.127.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 26, 2025 License: Apache-2.0 Imports: 6 Imported by: 2

README

osquery Receiver

Status
Stability development: logs
Distributions []
Issues Open issues Closed issues
Code coverage codecov
Code Owners @nslaughter, @smithclay

The osquery receiver runs queries run on an osquery's daemon on a schedule and converts the output to logs.

Configuration

The following settings are required:

  • queries: list of queries to run on an osquery daemon

The following settings are optional:

  • collection_interval (default = 10s): How often queries are run on the system
  • extensions_socket (default = /var/osquery/osquery.em): The osquery daemon's extension socket. Used to communicate with osquery on the system.

Getting started

osquery must be installed on the system where the collector is running. Once running as a daemon, the collector can connect to it using osquery's extension socket.

Example queries and data sources for querying are available in the osquery docs.

Example configuration

  osquery:
    collection_internal: 10s
    extensions_socket: /var/osquery/osquery.em
    queries:
      - "select * from certificates"
      - "select * from block_devices"

Documentation

Overview

Package osqueryreceiver emits osquery results as logs

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewFactory

func NewFactory() receiver.Factory

Types

type Config

type Config struct {
	scraperhelper.ControllerConfig `mapstructure:",squash"`
	ExtensionsSocket               string   `mapstructure:"extensions_socket"`
	Queries                        []string `mapstructure:"queries"`
}

func (Config) Validate

func (c Config) Validate() error

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL