api

package
v1.3.4 Latest Latest
Warning

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

 Go to latest Published: Dec 3, 2023 License: Apache-2.0 Imports: 55 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	MetricLatency = promauto.NewHistogramVec(prometheus.HistogramOpts{
		Name: "rekor_api_latency",
		Help: "Api Latency on calls",
	}, []string{"path", "code"})

	MetricLatencySummary = promauto.NewSummaryVec(prometheus.SummaryOpts{
		Name: "rekor_api_latency_summary",
		Help: "Api Latency on calls",
	}, []string{"path", "code"})

	MetricRequestLatency = promauto.NewHistogramVec(prometheus.HistogramOpts{
		Name: "rekor_latency_by_api",
		Help: "Api Latency (in ns) by path and method",
		Buckets: prometheus.ExponentialBucketsRange(
			float64(time.Millisecond),
			float64(4*time.Second),
			10),
	}, []string{"path", "method"})

	MetricRequestCount = promauto.NewCounterVec(prometheus.CounterOpts{
		Name: "rekor_qps_by_api",
		Help: "Api QPS by path, method, and response code",
	}, []string{"path", "method", "code"})

	CheckpointPublishCount = promauto.NewCounterVec(prometheus.CounterOpts{
		Name: "rekor_checkpoint_publish",
		Help: "Checkpoint publishing by shard and code",
	}, []string{"shard", "code"})
)
View Source 
var ErrNotFound = errors.New("grpc returned 0 leaves with success code")

Functions

func ConfigureAPI 

func ConfigureAPI(treeID uint)

func CreateLogEntryHandler 

func CreateLogEntryHandler(params entries.CreateLogEntryParams) middleware.Responder

CreateLogEntryHandler creates new entry into log

func CreateLogEntryNotImplementedHandler added in v1.0.0 

func CreateLogEntryNotImplementedHandler(_ entries.CreateLogEntryParams) middleware.Responder

func GetLogEntryByIndexHandler 

func GetLogEntryByIndexHandler(params entries.GetLogEntryByIndexParams) middleware.Responder

GetLogEntryAndProofByIndexHandler returns the entry and inclusion proof for a specified log index

func GetLogEntryByIndexNotImplementedHandler added in v1.0.0 

func GetLogEntryByIndexNotImplementedHandler(_ entries.GetLogEntryByIndexParams) middleware.Responder

func GetLogEntryByUUIDHandler 

func GetLogEntryByUUIDHandler(params entries.GetLogEntryByUUIDParams) middleware.Responder

GetLogEntryByUUIDHandler gets log entry and inclusion proof for specified UUID aka merkle leaf hash

func GetLogEntryByUUIDNotImplementedHandler added in v1.0.0 

func GetLogEntryByUUIDNotImplementedHandler(_ entries.GetLogEntryByUUIDParams) middleware.Responder

func GetLogInfoHandler 

func GetLogInfoHandler(params tlog.GetLogInfoParams) middleware.Responder

GetLogInfoHandler returns the current size of the tree and the STH

func GetLogInfoNotImplementedHandler added in v1.0.0 

func GetLogInfoNotImplementedHandler(_ tlog.GetLogInfoParams) middleware.Responder

func GetLogProofHandler 

func GetLogProofHandler(params tlog.GetLogProofParams) middleware.Responder

GetLogProofHandler returns information required to compute a consistency proof between two snapshots of log

func GetLogProofNotImplementedHandler added in v1.0.0 

func GetLogProofNotImplementedHandler(_ tlog.GetLogProofParams) middleware.Responder

func GetPublicKeyHandler 

func GetPublicKeyHandler(params pubkey.GetPublicKeyParams) middleware.Responder

func GetPublicKeyNotImplementedHandler added in v1.0.0 

func GetPublicKeyNotImplementedHandler(_ pubkey.GetPublicKeyParams) middleware.Responder

func SearchIndexHandler 

func SearchIndexHandler(params index.SearchIndexParams) middleware.Responder

func SearchIndexNotImplementedHandler 

func SearchIndexNotImplementedHandler(_ index.SearchIndexParams) middleware.Responder

func SearchLogQueryHandler 

func SearchLogQueryHandler(params entries.SearchLogQueryParams) middleware.Responder

SearchLogQueryHandler searches log by index, UUID, or proposed entry and returns array of entries found with inclusion proofs

func SearchLogQueryNotImplementedHandler added in v1.0.0 

func SearchLogQueryNotImplementedHandler(_ entries.SearchLogQueryParams) middleware.Responder

func StopAPI added in v1.2.0 

func StopAPI()

Types

type API 

type API struct {
	// contains filtered or unexported fields
}

func NewAPI 

func NewAPI(treeID uint) (*API, error)

type Collection added in v0.11.0 

type Collection struct {
	// contains filtered or unexported fields
}

Collection is a collection of sets.

its resulting values is a union or intersection of all the sets, depending on the operator.

func NewCollection added in v0.11.0 

func NewCollection(operator string) *Collection

NewCollection creates a new collection.

func (*Collection) Add added in v0.11.0 

func (u *Collection) Add(elements []string)

Add adds the elements into a new subset in the collection.

func (*Collection) Values added in v0.11.0 

func (u *Collection) Values() []string

Values flattens the subsets using the operator, and returns the collection as a slice of strings.

type Uniq added in v0.11.0 

type Uniq map[string]struct{}

Uniq is a collection of unique elements.

func NewUniq added in v0.11.0 

func NewUniq() Uniq

func (Uniq) Add added in v0.11.0 

func (u Uniq) Add(elements ...string)

func (Uniq) Intersect added in v0.11.0 

func (u Uniq) Intersect(other Uniq) Uniq

Intersect returns the intersection of two collections.

func (Uniq) Union added in v0.11.0 

func (u Uniq) Union(other Uniq) Uniq

Union returns the union of two collections.

func (Uniq) Values added in v0.11.0 

func (u Uniq) Values() []string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.