opentelemetrygithubactionsjunitreceiver

README

opentelemetry-github-actions-junit-receiver

Local Development

Prerequisites

• Go
• Gh

Install tools

Ngrok

The Ngrok can be installed by running:

make install-ngrok

ocb

The OpenTelemetry Collector Builder (OCB) can be installed by running:

make install-ocb

Build the collector

make build

Configure your GitHub repository for testing purposes

Open one terminal and run

make ngrok

Copy the ngrok URL and go to your GitHub repository, in this case we use elastic/oblt-project-tmpl:

• https://github.com/elastic/oblt-project-tmpl/settings/hooks
  • Payload: https://3012-37-133-56-13.ngrok-free.app/githubactionsjunit or the relevant ngrok URL
  • Content type: application/json
  • Secret: secret - fixed for now for testing purposes
  • Enable SSL verification
  • Individual events:
    • Workflow runs
    • Workflow jobs

Run the collector

make run

Documentation

Index

• Constants
• func NewFactory() receiver.Factory
• type Config

Constants

const (
	// suite keys
	FailedTestsCount  = "tests.suite.failed"
	ErrorTestsCount   = "tests.suite.error"
	PassedTestsCount  = "tests.suite.passed"
	SkippedTestsCount = "tests.suite.skipped"
	TestsDuration     = "tests.suite.duration"
	TestsSuiteName    = "tests.suite.suitename"
	TestsSystemErr    = "tests.suite.systemerr"
	TestsSystemOut    = "tests.suite.systemout"
	TotalTestsCount   = "tests.suite.total"

	// test keys
	TestClassName = "tests.case.classname"
	TestDuration  = "tests.case.duration"
	TestError     = "tests.case.error"
	TestMessage   = "tests.case.message"
	TestStatus    = "tests.case.status"
	TestSystemErr = "tests.case.systemerr"
	TestSystemOut = "tests.case.systemout"
)

Functions

func NewFactory

func NewFactory() receiver.Factory

NewFactory creates a factory for githubactionslogsreceiver.

Types

type Config

type Config struct {
	confighttp.ServerConfig `mapstructure:",squash"`
	Path                    string
	WebhookSecret           configopaque.String `mapstructure:"webhook_secret"`
	Token                   configopaque.String `mapstructure:"token"`
}