Documentation
¶
Index ¶
- Variables
- func ApiDumpDaemonsetAuthHandler(postmanAPIKey string, postmanEnv string) func(*http.Request) error
- func DaemonsetAuthHandler(postmanInsightsVerificationToken string) func(*http.Request) error
- func DefaultDomain() string
- func GetUserAgent() string
- func NewFrontClient(host string, cli akid.ClientID, authHandler func(*http.Request) error) *frontClientImpl
- func NewLearnClient(host string, cli akid.ClientID, svc akid.ServiceID, ...) *learnClientImpl
- func SetAPIErrorHandler(f APIErrorHandler)
- type APIErrorHandler
- type BaseClient
- type CreateServiceResponse
- type CreateSpecOptions
- type ErrorResponse
- type FrontClient
- type GetSpecOptions
- type HTTPError
- type InsightsService
- type LearnClient
- type PostmanMetaData
- type PostmanUser
- type Service
- type User
Constants ¶
This section is empty.
Variables ¶
var Domain string
This global setting identifies which back end to use, and defaults to api.observability.postman.com.
The domain is chosen based on the selected Postman environment (which may be the default or set in an environment variable.)
If the --domain flag is used, it unconditionally overrides this choice.
var ExpectedServerName string
Accept a server name other than the expected one in the TLS handshake
var ( // Shared client to maximize connection re-use. // TODO: make this private to the package once kgx package is removed. HTTPClient *retryablehttp.Client )
var ProxyAddress string
Use a proxy, "" is none. (This is because the flags package doesn't support Optional) May be a URL, a domain name, or an IP address. HTTP is assumed as the protocol if none is provided.
Functions ¶
func ApiDumpDaemonsetAuthHandler ¶ added in v0.34.0
ApiDumpDaemonsetAuthandler is used by the apidump functions if it is started by the kube daemonSet process. It excepts the postmanAPIKey and postmanEnv as arguments instead of reading it from the config.
func DaemonsetAuthHandler ¶ added in v0.34.0
DaemonsetAuthHandler is used by the daemonset process to authenticate the telemetry requests. it uses the postmanInsightsVerificationToken to authenticate the request.
func DefaultDomain ¶
func DefaultDomain() string
Return the default domain, given the settings in use
func GetUserAgent ¶
func GetUserAgent() string
func NewFrontClient ¶
func NewLearnClient ¶
func SetAPIErrorHandler ¶
func SetAPIErrorHandler(f APIErrorHandler)
Types ¶
type APIErrorHandler ¶
Error handling (to call into the telemetry library without creating a circular dependency.)
type BaseClient ¶
type BaseClient struct {
// contains filtered or unexported fields
}
func NewBaseClient ¶
func (BaseClient) Get ¶
func (c BaseClient) Get(ctx context.Context, path string, resp interface{}) error
Sends GET request and parses the response as JSON.
func (BaseClient) GetWithQuery ¶
type CreateServiceResponse ¶
type CreateSpecOptions ¶
type ErrorResponse ¶
type FrontClient ¶
type FrontClient interface { GetServices(context.Context) ([]Service, error) GetService(context.Context, akid.ServiceID) (InsightsService, error) GetUser(context.Context) (PostmanUser, error) CreateService(context.Context, string, string) (CreateServiceResponse, error) DaemonHeartbeat(ctx context.Context, daemonName string) error // Long-polls for changes to the set of active traces for a service. // Callers specify what they think the current set of active traces is. When // the cloud has a different set, this method returns options for capturing // new traces and a set of deactivated traces. An error is returned if the // connection is dropped (e.g., due to timing out). LongPollActiveTracesForService(context context.Context, daemonName string, serviceID akid.ServiceID, currentTraces []akid.LearnSessionID) (daemon.ActiveTraceDiff, error) // Post telemetry for the agent running as daemonset mode. PostDaemonsetAgentTelemetry(ctx context.Context, clusterName string) error }
type GetSpecOptions ¶
type GetSpecOptions struct {
EnableRelatedTypes bool
}
type InsightsService ¶
type LearnClient ¶
type LearnClient interface { ListLearnSessions( ctx context.Context, serviceID akid.ServiceID, tags map[tags.Key]string, limit int, offset int, ) ([]*kgxapi.ListedLearnSession, error) ListLearnSessionsWithStats(context.Context, akid.ServiceID, int) ([]*kgxapi.ListedLearnSession, error) GetLearnSession(context.Context, akid.ServiceID, akid.LearnSessionID) (*kgxapi.LearnSession, error) CreateLearnSession(context.Context, *kgxapi.APISpecReference, string, map[tags.Key]string) (akid.LearnSessionID, error) // Fetches the agent's dynamic configuration for the given service, as // specified by the user in the UI. GetDynamicAgentConfigForService( context.Context, akid.ServiceID, ) (*kgxapi.ServiceAgentConfig, error) // Uploads a batch of reports to Akita Cloud. This method is responsible for // filling in the ClientID in the given ReportsUploadRequest. AsyncReportsUpload(context.Context, akid.LearnSessionID, *kgxapi.UploadReportsRequest) error // Creates a spec from a set of learn sessions. CreateSpec(context.Context, string, []akid.LearnSessionID, CreateSpecOptions) (akid.APISpecID, error) GetSpec(context.Context, akid.APISpecID, GetSpecOptions) (kgxapi.GetSpecResponse, error) GetSpecVersion(context.Context, string) (kgxapi.APISpecVersion, error) UploadSpec(context.Context, kgxapi.UploadSpecRequest) (*kgxapi.UploadSpecResponse, error) // Resolve names. GetAPISpecIDByName(context.Context, string) (akid.APISpecID, error) GetLearnSessionIDByName(context.Context, string) (akid.LearnSessionID, error) // Spec diff GetSpecDiffTrie(context.Context, akid.APISpecID, akid.APISpecID) (*path_trie.PathTrie, error) // Telemetry PostClientPacketCaptureStats(context.Context, akid.ServiceID, kgxapi.PostClientPacketCaptureStatsRequest) error PostInitialClientTelemetry(context.Context, akid.ServiceID, kgxapi.PostInitialClientTelemetryRequest) error }
type PostmanMetaData ¶
type PostmanUser ¶
type Service ¶
type Service struct { ID akid.ServiceID `json:"id"` Name string `json:"name"` PostmanMetaData PostmanMetaData `json:"postman_meta_data"` }
TODO: shouldn't this be in akita-cli/api_schema?
type User ¶
type User = api_schema.UserResponse