oktareceiver

README

Okta Receiver

This receiver is capable of collecting logs from an Okta domain.

Minimum Agent Versions

• Introduced: v1.59.0

Supported Pipelines

• Logs

How It Works

1. The user configures this receiver in a pipeline.
2. The user configures a supported component to route telemetry from this receiver.

Prerequisites

• An Okta API Token will be needed to authorize the receiver with your Okta Domain.

Configuration

Field	Type	Default	Required	Description
okta_domain	string		true	The Okta domain the receiver should collect logs from (Do not include "https://"): Find your Okta Domain
api_token	string		true	An Okta API Token generated from the above Okta domain: How to Create an Okta API Token
poll_interval	string	1m	false	The rate at which this receiver will poll Okta for logs. This value must be in the range [1 second - 24 hours] and must be a string readable by Golang's time.ParseDuration.

Example Configuration

receivers:
  okta:
    okta_domain: example.okta.com
    api_token: 11Z-XDEwgRIf4p0-RqbSFoplFh_84EOtC_ka4J7ylx
    poll_interval: 2m
exporters:
  googlecloud:
    project: my-gcp-project

service:
  pipelines:
    logs:
      receivers: [okta]
      exporters: [googlecloud]

Documentation

Overview

Package oktareceiver provides a receiver that receives telemetry from an Okta domain.

Index

• Variables
• func NewFactory() receiver.Factory
• type Config
  • func (c *Config) Validate() error

Variables

var (

	// OktaTimeFormat ISO 8601 Format
	OktaTimeFormat = "2006-01-02T15:04:05Z"
)

Functions

func NewFactory

func NewFactory() receiver.Factory

NewFactory creates a new factory for the Okta receiver

Types

type Config

type Config struct {
	// Domain Okta Domain (no https://  -  ex: observiq.okta.com)
	Domain string `mapstructure:"okta_domain"`

	// APIToken Okta API Token
	APIToken configopaque.String `mapstructure:"api_token"`

	// PollInterval The interval at which the Okta API is scanned for Logs
	// Must be in the range [1 second - 24 hours]
	PollInterval time.Duration `mapstructure:"poll_interval"`
}

Config defines the configuration for an Okta receiver

func (*Config) Validate

func (c *Config) Validate() error

Validate ensures an Okta receiver config is correct