api

package

v0.10.1 Latest Latest Go to latest Published: Apr 1, 2026 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/apache/skywalking-banyandb

Links

Open Source Insights

Documentation ¶

Overview ¶

Package api provides functionality for the API server.

Index ¶

type Server
- func NewServer(metricsAggregator *metrics.Aggregator, clusterStateCollector *cluster.Manager, ...) *Server
- func (s *Server) Start(listenAddr string, readTimeout, writeTimeout time.Duration) error
- func (s *Server) Stop() error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Server ¶

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

Server exposes REST and Prometheus-style endpoints for external consumption.

func NewServer ¶

func NewServer(
	metricsAggregator *metrics.Aggregator,
	clusterStateCollector *cluster.Manager,
	lifecycleManager *lifecycle.Manager,
	registry *registry.AgentRegistry,
	logger *logger.Logger,
) *Server

NewServer creates a new Server instance.

func (*Server) Start ¶

func (s *Server) Start(listenAddr string, readTimeout, writeTimeout time.Duration) error

Start starts the HTTP server.

func (*Server) Stop ¶

func (s *Server) Stop() error

Stop gracefully stops the HTTP server.

Source Files ¶

View all Source files

server.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL