elephantine

Apr 18, 2026

Changes in this version

type APIServerOption

+ func APIServerModules(modules ...string) APIServerOption

+ func APIServerVersion(version string) APIServerOption

+ type ApplicationInfo struct

+ Name string

+ VCSModified bool

+ VCSRevision string

+ VCSTime string

+ Version string

+ type BuildInfo struct

+ Application ApplicationInfo

+ Modules map[string]string

Mar 2, 2026

Changes in this version

+ type CertificateSource struct

+ func NewCertificateSource(logger *slog.Logger, certFile string, keyFile string, ...) (*CertificateSource, error)

+ func (cs *CertificateSource) GetCertificate(_ *tls.ClientHelloInfo) (*tls.Certificate, error)

+ func (cs *CertificateSource) Run(ctx context.Context) error

+ type CertificateSourceOption func(*CertificateSource)

+ func CertSourcePollInterval(d time.Duration) CertificateSourceOption

+ func CertSourceSettleDelay(d time.Duration) CertificateSourceOption

Feb 4, 2026

Changes in this version

type JWTClaims

+ Org string

Jan 14, 2026

Changes in this version

type APIServerOption

+ func APIServerTLS(addr string, certFile string, keyFile string) APIServerOption

+ type ListenAndServeOption func(s *http.Server, o *ListenAndServeOptions)

+ func ListenAndServeTLS(certFile string, keyFile string) ListenAndServeOption

+ type ListenAndServeOptions struct

Jan 8, 2026

Changes in this version

+ func ContextWithFeatureFlags(ctx context.Context, flags map[string]bool) context.Context

+ func FeatureIsEnabled(ctx context.Context, flag string, defaultState bool) bool

Dec 15, 2025

Changes in this version

type MetricsHelper

+ func (h *MetricsHelper) Histogram(o *prometheus.Histogram, opts prometheus.HistogramOpts)

+ func (h *MetricsHelper) HistogramVec(o **prometheus.HistogramVec, opts prometheus.HistogramOpts, labels []string)

Dec 15, 2025

Changes in this version

+ type MetricsHelper struct

+ func NewMetricsHelper(reg prometheus.Registerer) *MetricsHelper

+ func (h *MetricsHelper) Counter(o *prometheus.Counter, opts prometheus.CounterOpts)

+ func (h *MetricsHelper) CounterVec(o **prometheus.CounterVec, opts prometheus.CounterOpts, labels []string)

+ func (h *MetricsHelper) Err() error

+ func (h *MetricsHelper) Gauge(o *prometheus.Gauge, opts prometheus.GaugeOpts)

+ func (h *MetricsHelper) GaugeVec(o **prometheus.GaugeVec, opts prometheus.GaugeOpts, labels []string)

Nov 11, 2025

Changes in this version

+ func CallWithRecover(ctx context.Context, fn func(ctx context.Context) error) (outErr error)

+ type ErrPanicRecovered struct

+ PanicValue any

+ func (err ErrPanicRecovered) Error() string

Oct 30, 2025

Changes in this version

type APIServer

+ func (s *APIServer) RegisterAPIs(opt ServiceOptions, apis ...APIServiceHandler)

Oct 30, 2025

Changes in this version

+ var ErrGracefulQuit = errors.New("quit requested")

+ var ErrGracefulStop = errors.New("stop requested")

Oct 3, 2025

Changes in this version

+ const DialTimeoutExternal

+ const DialTimeoutInternal

+ const DialTimeoutSlow

+ func NewHTTPClient(timeout time.Duration, opts ...HTTPClientOption) *http.Client

+ type HTTPClientOption func(opts *HTTPClientOptions)

+ func DialTimeout(d time.Duration) HTTPClientOption

+ func IdleConnections(maxIdle int, maxIdlePerHost int, idleConnTimeout time.Duration) HTTPClientOption

+ func LongpollClient() HTTPClientOption

+ func MaxConnectionsPerHost(n int) HTTPClientOption

+ func ResponseHeaderTimeout(d time.Duration) HTTPClientOption

+ func TLSHandshakeTimeout(d time.Duration) HTTPClientOption

+ func WithTokenSource(source oauth2.TokenSource) HTTPClientOption

+ type HTTPClientOptions struct

Sep 11, 2025

Changes in this version

type AuthenticationConfig

+ func AuthenticationConfigFromSettings(ctx context.Context, settings AuthenticationSettings, scopes []string) (*AuthenticationConfig, error)

+ type AuthenticationSettings struct

+ Audience string

+ ClientID string

+ ClientSecret string

+ OIDCConfig string

+ ScopePrefix string

Aug 20, 2025

Changes in this version

type JWTAuthInfoParser

+ func NewJWTAuthInfoParser(ctx context.Context, keyfunc jwt.Keyfunc, opts JWTAuthInfoParserOptions) *JWTAuthInfoParser

May 25, 2025

Changes in this version

+ const LogKeyDocumentTitle

May 15, 2025

Changes in this version

+ const LogKeyDocumentType

May 10, 2025

Changes in this version

type CORSOptions

+ HostPatterns []string

May 10, 2025

Changes in this version

+ type APIServerOption func(s *APIServer)

+ func APIServerCORSHosts(hosts ...string) APIServerOption

Apr 4, 2025

Changes in this version

+ const LogKeyAlertCode

+ func InvalidArgumentf(argument string, format string, a ...any) error

Mar 31, 2025

Changes in this version

type AuthInfoParser

+ AuthInfoFromToken func(token string) (*AuthInfo, error)

+ ValidateTokenWithClaims func(token string, claims jwt.Claims) (*jwt.Token, error)

type JWTAuthInfoParser

+ func (p *JWTAuthInfoParser) AuthInfoFromToken(token string) (*AuthInfo, error)

+ func (p *JWTAuthInfoParser) ValidateTokenWithClaims(token string, claims jwt.Claims) (*jwt.Token, error)

Mar 3, 2025

Changes in this version

+ func Close(name string, c io.Closer, outErr *error)

Jan 14, 2025

Changes in this version

type APIServer

+ func NewTestAPIServer(t Cleaner, logger *slog.Logger) *APIServer

+ func (s *APIServer) Addr() string

+ type Cleaner interface

+ Cleanup func(fn func())

type HealthServer

+ func (s *HealthServer) Addr() string

Nov 28, 2024

Changes in this version

type JWTClaims

+ ClientID string

Nov 25, 2024

Changes in this version

+ type JWTAuthInfoParser struct

+ func (p *JWTAuthInfoParser) AuthInfoFromHeader(authorization string) (*AuthInfo, error)

+ func (p *JWTAuthInfoParser) Valid(c JWTClaims) error

+ type JWTAuthInfoParserOptions struct

+ Audience string

+ Issuer string

+ ScopePrefix string

+ type ServiceAuth bool

+ const ServiceAuthOptional

+ const ServiceAuthRequired

type ServiceOptions

+ JSONSkipDefaults bool

+ func (so *ServiceOptions) ServerOptions() twirp.ServerOption

+ func (so *ServiceOptions) SetAuthInfoValidation(parser AuthInfoParser, requireAuth ServiceAuth)

Nov 8, 2024

Changes in this version

type APIServer

+ CORS *CORSOptions

Oct 10, 2024

Changes in this version

type ServiceOptions

+ func (so *ServiceOptions) AddMetricsHooks(reg prometheus.Registerer) error

Oct 4, 2024

Changes in this version

+ const LogKeyAttempts

+ func HTTPErrorHandlerFunc(fn func(http.ResponseWriter, *http.Request) error) http.HandlerFunc

+ type APIServer struct

+ Health *HealthServer

+ Mux *http.ServeMux

+ func NewAPIServer(logger *slog.Logger, addr string, profileAddr string) *APIServer

+ func (s *APIServer) AliveEndpoint() string

+ func (s *APIServer) ListenAndServe(ctx context.Context) error

+ func (s *APIServer) RegisterAPI(api APIServiceHandler, opt ServiceOptions)

+ type APIServiceHandler interface

+ PathPrefix func() string

type AuthInfo

+ func RequireAnyScope(ctx context.Context, scopes ...string) (*AuthInfo, error)

+ type BackoffFunction func(retry int) time.Duration

+ func StaticBackoff(wait time.Duration) BackoffFunction

+ type ErrGroup struct

+ func NewErrGroup(ctx context.Context, logger *slog.Logger) *ErrGroup

+ func (eg *ErrGroup) Go(task string, fn func(ctx context.Context) error)

+ func (eg *ErrGroup) GoWithRetries(task string, maxRetries int, backoff BackoffFunction, resetAfter time.Duration, ...)

+ func (eg *ErrGroup) Wait() error

+ type ServiceOptions struct

+ AuthMiddleware func(w http.ResponseWriter, r *http.Request, next http.Handler) error

+ Hooks *twirp.ServerHooks

+ func NewDefaultServiceOptions(logger *slog.Logger, parser *AuthInfoParser) ServiceOptions

+ func (so *ServiceOptions) AddLoggingHooks(logger *slog.Logger, scopesFunc func(context.Context) string)

+ func (so *ServiceOptions) SetJWTValidation(parser *AuthInfoParser, requireAuth bool)

Sep 30, 2024

Changes in this version

type AuthInfo

+ Token string

Sep 26, 2024

Changes in this version

type AuthenticationConfig

+ func (conf *AuthenticationConfig) NewTokenSource(ctx context.Context, scopes []string) (oauth2.TokenSource, error)

Sep 25, 2024

Changes in this version

+ func AuthenticationCLIFlags() []cli.Flag

Sep 23, 2024

Changes in this version

+ func OpenIDConnectParameters() []cli.Flag

+ type AuthenticationConfig struct

+ AuthParser *AuthInfoParser

+ OIDCConfig *OpenIDConnectConfig

+ TokenSource oauth2.TokenSource

+ func AuthenticationConfigFromCLI(c *cli.Context, paramSource ParameterSource, scopes []string) (*AuthenticationConfig, error)

+ type OpenIDConnectConfig struct

+ AcrValuesSupported []string

+ AuthorizationEncryptionAlgValuesSupported []string

+ AuthorizationEncryptionEncValuesSupported []string

+ AuthorizationEndpoint string

+ AuthorizationResponseIssParameterSupported bool

+ AuthorizationSigningAlgValuesSupported []string

+ BackchannelAuthenticationEndpoint string

+ BackchannelAuthenticationRequestSigningAlgValuesSupported []string

+ BackchannelLogoutSessionSupported bool

+ BackchannelLogoutSupported bool

+ BackchannelTokenDeliveryModesSupported []string

+ CheckSessionIframe string

+ ClaimTypesSupported []string

+ ClaimsParameterSupported bool

+ ClaimsSupported []string

+ CodeChallengeMethodsSupported []string

+ DeviceAuthorizationEndpoint string

+ EndSessionEndpoint string

+ FrontchannelLogoutSessionSupported bool

+ FrontchannelLogoutSupported bool

+ GrantTypesSupported []string

+ IDTokenEncryptionAlgValuesSupported []string

+ IDTokenEncryptionEncValuesSupported []string

+ IDTokenSigningAlgValuesSupported []string

+ IntrospectionEndpoint string

+ IntrospectionEndpointAuthMethodsSupported []string

+ IntrospectionEndpointAuthSigningAlgValuesSupported []string

+ Issuer string

+ JwksURI string

+ MtlsEndpointAliases map[string]string

+ PushedAuthorizationRequestEndpoint string

+ RegistrationEndpoint string

+ RequestObjectEncryptionAlgValuesSupported []string

+ RequestObjectEncryptionEncValuesSupported []string

+ RequestObjectSigningAlgValuesSupported []string

+ RequestParameterSupported bool

+ RequestURIParameterSupported bool

+ RequirePushedAuthorizationRequests bool

+ RequireRequestURIRegistration bool

+ ResponseModesSupported []string

+ ResponseTypesSupported []string

+ RevocationEndpoint string

+ RevocationEndpointAuthMethodsSupported []string

+ RevocationEndpointAuthSigningAlgValuesSupported []string

+ ScopesSupported []string

+ SubjectTypesSupported []string

+ TLSClientCertificateBoundAccessTokens bool

+ TokenEndpoint string

+ TokenEndpointAuthMethodsSupported []string

+ TokenEndpointAuthSigningAlgValuesSupported []string

+ UserinfoEncryptionAlgValuesSupported []string

+ UserinfoEncryptionEncValuesSupported []string

+ UserinfoEndpoint string

+ UserinfoSigningAlgValuesSupported []string

+ func OpenIDConnectConfigFromURL(wellKnown string) (*OpenIDConnectConfig, error)

Jun 12, 2024

Changes in this version

type JWTClaims

+ AuthorizedParty string

+ OriginalSub string

May 15, 2024

Changes in this version

+ func ScopePrefixRegexp(prefix string) *regexp.Regexp

+ type AuthInfoParser struct

+ func NewJWKSAuthInfoParser(ctx context.Context, jwksUrl string, opts AuthInfoParserOptions) (*AuthInfoParser, error)

+ func NewStaticAuthInfoParser(key ecdsa.PublicKey, opts AuthInfoParserOptions) *AuthInfoParser

+ func (p *AuthInfoParser) AuthInfoFromHeader(authorization string) (*AuthInfo, error)

+ func (p *AuthInfoParser) Valid(c JWTClaims) error

+ type AuthInfoParserOptions struct

+ Audience string

+ Issuer string

+ ScopePrefix string

Jan 23, 2024

Changes in this version

type CORSOptions

+ AllowInsecureLocalhost bool

Jan 23, 2024

Changes in this version

+ func CORSMiddleware(opts CORSOptions, handler http.Handler) http.Handler

+ type CORSOptions struct

+ AllowInsecure bool

+ AllowedHeaders []string

+ AllowedMethods []string

+ Hosts []string

+ MaxAgeSeconds int

Dec 14, 2023

Changes in this version

+ func LogMetadataMiddleware(next http.Handler) http.Handler

Dec 11, 2023

Changes in this version

type TwirpMetricOptionFunc

+ func WithTwirpMetricsCustomerFunc(fn func(ctx context.Context) string) TwirpMetricOptionFunc

Nov 23, 2023

Changes in this version

type HealthServer

+ func NewTestHealthServer() *HealthServer

Nov 6, 2023

Changes in this version

type GracefulShutdown

+ func NewManualGracefulShutdown(logger *slog.Logger, timeout time.Duration) *GracefulShutdown

Oct 31, 2023

Changes in this version

+ const DefaultAuthRole

+ const DefaultServiceAccountTokenPath

+ const EnvServiceAccountToken

+ const EnvVaultAuthRole

+ type Vault struct

+ Client *vault.Client

+ func NewVault() (*Vault, error)

+ func (v *Vault) GetParameterValue(ctx context.Context, name string) (string, error)

+ func (v *Vault) KeepAlive() error

+ func (v *Vault) Stop()

Oct 26, 2023

Changes in this version

+ func TwirpErrorToHTTPStatusCode(err error) int

Sep 15, 2023

Changes in this version

+ func MarshalFile(path string, o interface{}) (outErr error)

Aug 22, 2023

Changes in this version

+ const LogKeyDocumentStatus

+ const LogKeyDocumentStatusID

+ const LogKeyDocumentVersion

Jun 14, 2023

Changes in this version

type ReadyFunc

+ func LivenessReadyCheck(endpoint string) ReadyFunc

May 31, 2023

Changes in this version

+ const LogKeyName

+ func SafeClose(logger *slog.Logger, name string, c io.Closer)

May 29, 2023

Changes in this version

+ var ErrNoAuthorization = errors.New("no authorization provided")

+ func SetAuthInfo(ctx context.Context, info *AuthInfo) context.Context

+ type AuthInfo struct

+ Claims JWTClaims

+ func AuthInfoFromHeader(key *ecdsa.PublicKey, authorization string) (*AuthInfo, error)

+ func GetAuthInfo(ctx context.Context) (*AuthInfo, bool)

+ type JWTClaims struct

+ Name string

+ Scope string

+ Units []string

+ func (c JWTClaims) HasAnyScope(names ...string) bool

+ func (c JWTClaims) HasScope(name string) bool

+ func (c JWTClaims) Valid() error

May 29, 2023

Changes in this version

+ const LogKeyErrorCode

+ const LogKeyErrorMeta

+ const LogKeyScopes

+ const LogKeyStatusCode

+ const LogKeySubject

+ func GetLogMetadata(ctx context.Context) map[string]any

+ func LoggingHooks(logger *slog.Logger, scopesFunc func(context.Context) string) *twirp.ServerHooks

+ func SetLogMetadata(ctx context.Context, key string, value any)

+ func WithLogMetadata(ctx context.Context) context.Context

May 25, 2023

Changes in this version

+ func IsTwirpErrorCode(err error, code twirp.ErrorCode) bool

+ func NewTwirpMetricsHooks(opts ...TwirpMetricOptionFunc) (*twirp.ServerHooks, error)

+ type GracefulShutdown struct

+ func NewGracefulShutdown(logger *slog.Logger, timeout time.Duration) *GracefulShutdown

+ func (gs *GracefulShutdown) CancelOnQuit(ctx context.Context) context.Context

+ func (gs *GracefulShutdown) CancelOnStop(ctx context.Context) context.Context

+ func (gs *GracefulShutdown) ShouldQuit() <-chan struct{}

+ func (gs *GracefulShutdown) ShouldStop() <-chan struct{}

+ func (gs *GracefulShutdown) Stop()

+ type HTTPClientInstrumentation struct

+ func NewHTTPClientIntrumentation(registerer prometheus.Registerer) (*HTTPClientInstrumentation, error)

+ func (ci *HTTPClientInstrumentation) Client(name string, client *http.Client) error

+ type TwirpMetricOptionFunc func(opts *TwirpMetricsOptions)

+ func WithTwirpMetricsRegisterer(reg prometheus.Registerer) TwirpMetricOptionFunc

+ func WithTwirpMetricsStaticTestLatency(latency time.Duration) TwirpMetricOptionFunc

+ type TwirpMetricsOptions struct

May 10, 2023

Changes in this version

+ const LogKeyMethod

+ const LogKeyRoute

+ const LogKeyService

May 2, 2023

Changes in this version

+ const LogKeyBucket

+ const LogKeyChannel

+ const LogKeyComponent

+ const LogKeyCount

+ const LogKeyCountMetric

+ const LogKeyDelay

+ const LogKeyDocumentUUID

+ const LogKeyError

+ const LogKeyEventID

+ const LogKeyEventType

+ const LogKeyIndex

+ const LogKeyJobLock

+ const LogKeyJobLockID

+ const LogKeyLogLevel

+ const LogKeyMessage

+ const LogKeyOCEvent

+ const LogKeyOCSource

+ const LogKeyOCVersion

+ const LogKeyObjectKey

+ const LogKeyState

+ const LogKeyTransaction

+ func IsHTTPErrorWithStatus(err error, status int) bool

+ func ListenAndServeContext(ctx context.Context, server *http.Server) error

+ func RHandleFunc(fn func(http.ResponseWriter, *http.Request, httprouter.Params) error) httprouter.Handle

+ func ResolveParameter(c *cli.Context, src ParameterSource, name string) (string, error)

+ func SetUpLogger(logLevel string, w io.Writer) *slog.Logger

+ func UnmarshalFile(path string, o interface{}) error

+ func UnmarshalHTTPResource(resURL string, o interface{}) error

+ type HTTPError struct

+ Body io.Reader

+ Header http.Header

+ Status string

+ StatusCode int

+ func HTTPErrorFromResponse(res *http.Response) *HTTPError

+ func HTTPErrorf(statusCode int, format string, a ...any) *HTTPError

+ func NewHTTPError(statusCode int, message string) *HTTPError

+ func (e *HTTPError) Error() string

+ type HealthServer struct

+ func NewHealthServer(addr string) *HealthServer

+ func (s *HealthServer) AddReadyFunction(name string, fn ReadyFunc)

+ func (s *HealthServer) Close() error

+ func (s *HealthServer) ListenAndServe(ctx context.Context) error

+ type LazySSM struct

+ func NewLazySSM() *LazySSM

+ func (l *LazySSM) GetParameterValue(ctx context.Context, name string) (string, error)

+ type ParameterSource interface

+ GetParameterValue func(ctx context.Context, name string) (string, error)

+ func GetParameterSource(name string) (ParameterSource, error)

+ type ReadyFunc func(ctx context.Context) error

+ type ReadyResult struct

+ Error string

+ Ok bool