Documentation
¶
Index ¶
- Variables
- type AppConfig
- type AuditLogger
- type AutoPprof
- type Backup
- type Capabilities
- type Database
- type DatabaseBackupMode
- type Feature
- type File
- type FluxMonitor
- type Insecure
- type JobPipeline
- type Keeper
- type LDAP
- type Listener
- type Lock
- type Log
- type LogfFn
- type MFA
- type Mercury
- type MercuryCache
- type MercuryTLS
- type OCR
- type OCR2
- type P2P
- type Password
- type Prometheus
- type Pyroscope
- type RateLimit
- type Registry
- type Sentry
- type TLS
- type TelemetryIngress
- type TelemetryIngressEndpoint
- type Threshold
- type Tracing
- type V2
- type WebServer
Constants ¶
This section is empty.
Variables ¶
View Source
var (
ErrEnvUnset = pkgerrors.New("env var unset")
)
nolint
Functions ¶
This section is empty.
Types ¶
type AppConfig ¶ added in v2.2.0
type AppConfig interface {
AppID() uuid.UUID
RootDir() string
ShutdownGracePeriod() time.Duration
InsecureFastScrypt() bool
EVMEnabled() bool
EVMRPCEnabled() bool
CosmosEnabled() bool
SolanaEnabled() bool
StarkNetEnabled() bool
Validate() error
ValidateDB() error
LogConfiguration(log, warn LogfFn)
SetLogLevel(lvl zapcore.Level) error
SetLogSQL(logSQL bool)
SetPasswords(keystore, vrf *string)
AuditLogger() AuditLogger
AutoPprof() AutoPprof
Capabilities() Capabilities
Database() Database
Feature() Feature
FluxMonitor() FluxMonitor
Insecure() Insecure
JobPipeline() JobPipeline
Keeper() Keeper
Log() Log
Mercury() Mercury
OCR() OCR
OCR2() OCR2
P2P() P2P
Password() Password
Prometheus() Prometheus
Pyroscope() Pyroscope
Sentry() Sentry
TelemetryIngress() TelemetryIngress
Threshold() Threshold
WebServer() WebServer
Tracing() Tracing
}
type AuditLogger ¶ added in v2.3.0
type AuditLogger interface {
Enabled() bool
ForwardToUrl() (commonconfig.URL, error)
Environment() string
JsonWrapperKey() string
Headers() (models.ServiceHeaders, error)
}
type AutoPprof ¶ added in v2.2.0
type AutoPprof interface {
BlockProfileRate() int
CPUProfileRate() int
Enabled() bool
GatherDuration() commonconfig.Duration
GatherTraceDuration() commonconfig.Duration
GoroutineThreshold() int
MaxProfileSize() utils.FileSize
MemProfileRate() int
MemThreshold() utils.FileSize
MutexProfileFraction() int
PollInterval() commonconfig.Duration
ProfileRoot() string
}
type Capabilities ¶ added in v2.11.0
type Capabilities interface {
Peering() P2P
}
type Database ¶ added in v2.2.0
type Database interface {
Backup() Backup
Listener() Listener
Lock() Lock
DefaultIdleInTxSessionTimeout() time.Duration
DefaultLockTimeout() time.Duration
DefaultQueryTimeout() time.Duration
Dialect() dialects.DialectName
LogSQL() bool
MaxIdleConns() int
MaxOpenConns() int
MigrateDatabase() bool
URL() url.URL
}
type DatabaseBackupMode ¶
type DatabaseBackupMode string
var ( DatabaseBackupModeNone DatabaseBackupMode = "none" DatabaseBackupModeLite DatabaseBackupMode = "lite" DatabaseBackupModeFull DatabaseBackupMode = "full" )
type FluxMonitor ¶ added in v2.2.0
type JobPipeline ¶ added in v2.2.0
type JobPipeline interface {
DefaultHTTPLimit() int64
DefaultHTTPTimeout() commonconfig.Duration
MaxRunDuration() time.Duration
MaxSuccessfulRuns() uint64
ReaperInterval() time.Duration
ReaperThreshold() time.Duration
ResultWriteQueueDepth() uint64
ExternalInitiatorsEnabled() bool
VerboseLogging() bool
}
type LDAP ¶ added in v2.8.0
type LDAP interface {
ServerAddress() string
ReadOnlyUserLogin() string
ReadOnlyUserPass() string
ServerTLS() bool
SessionTimeout() commonconfig.Duration
QueryTimeout() time.Duration
BaseUserAttr() string
BaseDN() string
UsersDN() string
GroupsDN() string
ActiveAttribute() string
ActiveAttributeAllowedValue() string
AdminUserGroupCN() string
EditUserGroupCN() string
RunUserGroupCN() string
ReadUserGroupCN() string
UserApiTokenEnabled() bool
UserAPITokenDuration() commonconfig.Duration
UpstreamSyncInterval() commonconfig.Duration
UpstreamSyncRateLimit() commonconfig.Duration
}
type Mercury ¶ added in v2.3.0
type Mercury interface {
Credentials(credName string) *types.MercuryCredentials
Cache() MercuryCache
TLS() MercuryTLS
}
type MercuryCache ¶ added in v2.8.0
type MercuryTLS ¶ added in v2.9.0
type MercuryTLS interface {
CertFile() string
}
type OCR ¶ added in v2.3.0
type OCR interface {
Enabled() bool
// OCR1 config, can override in jobs, only ethereum.
BlockchainTimeout() time.Duration
ContractPollInterval() time.Duration
ContractSubscribeInterval() time.Duration
KeyBundleID() (string, error)
ObservationTimeout() time.Duration
SimulateTransactions() bool
TransmitterAddress() (types.EIP55Address, error) // OCR2 can support non-evm changes
// OCR1 config, cannot override in jobs
TraceLogging() bool
DefaultTransactionQueueDepth() uint32
CaptureEATelemetry() bool
}
OCR is a subset of global config relevant to OCR v1.
type OCR2 ¶ added in v2.3.0
type OCR2 interface {
Enabled() bool
// OCR2 config, can override in jobs, all chains
ContractConfirmations() uint16
ContractTransmitterTransmitTimeout() time.Duration
BlockchainTimeout() time.Duration
DatabaseTimeout() time.Duration
ContractPollInterval() time.Duration
ContractSubscribeInterval() time.Duration
KeyBundleID() (string, error)
// OCR2 config, cannot override in jobs
TraceLogging() bool
CaptureEATelemetry() bool
DefaultTransactionQueueDepth() uint32
SimulateTransactions() bool
CaptureAutomationCustomTelemetry() bool
}
OCR2 is a subset of global config relevant to OCR v2.
type Prometheus ¶ added in v2.2.0
type Prometheus interface {
AuthToken() string
}
type TelemetryIngress ¶ added in v2.2.0
type TelemetryIngressEndpoint ¶ added in v2.7.0
type V2 ¶ added in v2.3.0
type V2 interface {
Enabled() bool
AnnounceAddresses() []string
DefaultBootstrappers() (locators []ocrcommontypes.BootstrapperLocator)
DeltaDial() commonconfig.Duration
DeltaReconcile() commonconfig.Duration
ListenAddresses() []string
}
type WebServer ¶ added in v2.3.0
type WebServer interface {
AuthenticationMethod() string
AllowOrigins() string
BridgeCacheTTL() time.Duration
BridgeResponseURL() *url.URL
HTTPMaxSize() int64
StartTimeout() time.Duration
HTTPWriteTimeout() time.Duration
HTTPPort() uint16
SessionReaperExpiration() commonconfig.Duration
SecureCookies() bool
SessionOptions() sessions.Options
SessionTimeout() commonconfig.Duration
ListenIP() net.IP
TLS() TLS
RateLimit() RateLimit
MFA() MFA
LDAP() LDAP
}
Source Files
¶
- app_config.go
- audit_logger_config.go
- auto_pprof_config.go
- capabilities_config.go
- database_config.go
- feature_config.go
- flux_monitor_config.go
- insecure_config.go
- job_pipeline_config.go
- keeper_config.go
- logging_config.go
- mercury_config.go
- ocr2_config.go
- ocr_config.go
- p2p_config.go
- p2p_v2_config.go
- password_config.go
- prometheus.go
- pyroscope_config.go
- sentry_config.go
- telemetry_ingress_config.go
- threshold_config.go
- tracing_config.go
- web_config.go
Click to show internal directories.
Click to hide internal directories.