apitoolkit_tlsclient

README

Golang tls-client SDK

APItoolkit is an end-to-end API and web services management toolkit for engineers and customer support teams. To integrate your Golang application with APItoolkit, you need to use this SDK to monitor incoming traffic, aggregate the requests, and then deliver them to the APItoolkit's servers.

---

Table of Contents

• Installation
• Configuration
• Contributing and Help
• License

---

Installation

Kindly run the command below to install the SDK:

go get github.com/apitoolkit/apitoolkit-go-tlsclient

Then add github.com/apitoolkit/apitoolkit-go to the list of dependencies like so:

package main

import (
  apitoolkit "github.com/apitoolkit/apitoolkit-go"
)

Configuration

Next, initialize APItoolkit in your application's entry point (e.g., main.go) like so:

package main

import (
  "context"
  "log"
  "net/http"
  apitoolkit "github.com/apitoolkit/apitoolkit-go"
)

func main() {
  ctx := context.Background()

  // Initialize the client
  apitoolkitClient, err := apitoolkit.NewClient(ctx, apitoolkit.Config{APIKey: "{ENTER_YOUR_API_KEY_HERE}"})
  if err != nil {
    panic(err)
  }

  // Register APItoolkit's middleware
  http.Handle("/", apitoolkitClient.Middleware(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
    w.WriteHeader(http.StatusOK)
    w.Write([]byte("Hello, World!"))
  })))

  http.ListenAndServe(":8080", nil)
}

[!NOTE]

• This SDK supports multiple Golang frameworks (including, Chi, Echo, Fiber, Gin, Gorilla Mux, and Native). You can learn how to configure each framework using the provided Middleware (e.g., EchoMiddleware) in the respective linked docs above.
• The {ENTER_YOUR_API_KEY_HERE} demo string should be replaced with the API key generated from the APItoolkit dashboard.

[!IMPORTANT]

To learn more configuration options (redacting fields, error reporting, outgoing requests, etc.), please read this SDK documentation.

Contributing and Help

To contribute to the development of this SDK or request help from the community and our team, kindly do any of the following:

• Read our Contributors Guide.
• Join our community Discord Server.
• Create a new issue in this repository.

License

This repository is published under the MIT license.

---

Documentation

Index

• func BuildPayload(c *apitoolkit.Client, SDKType string, trackingStart time.Time, ...) apitoolkit.Payload
• type InstrumentedHttpClient
  • func NewHttpClient(ctx context.Context, client tls_client.HttpClient, ...) *InstrumentedHttpClient
  • func (c *InstrumentedHttpClient) CloseIdleConnections()
  • func (c *InstrumentedHttpClient) Do(req *fhttp.Request) (res *fhttp.Response, err error)
  • func (c *InstrumentedHttpClient) Get(url string) (*fhttp.Response, error)
  • func (c *InstrumentedHttpClient) GetCookieJar() fhttp.CookieJar
  • func (c *InstrumentedHttpClient) GetCookies(u *url.URL) []*fhttp.Cookie
  • func (c *InstrumentedHttpClient) GetFollowRedirect() bool
  • func (c *InstrumentedHttpClient) GetProxy() string
  • func (c *InstrumentedHttpClient) Head(url string) (*fhttp.Response, error)
  • func (c *InstrumentedHttpClient) Post(url, contentType string, body io.Reader) (*fhttp.Response, error)
  • func (c *InstrumentedHttpClient) SetCookieJar(jar fhttp.CookieJar)
  • func (c *InstrumentedHttpClient) SetCookies(u *url.URL, cookies []*fhttp.Cookie)
  • func (c *InstrumentedHttpClient) SetFollowRedirect(followRedirect bool)
  • func (c *InstrumentedHttpClient) SetProxy(proxyUrl string) error

Functions

func BuildPayload

func BuildPayload(c *apitoolkit.Client, SDKType string, trackingStart time.Time, req *fhttp.Request,
	statusCode int, reqBody []byte, respBody []byte, respHeader map[string][]string,
	pathParams map[string]string, urlPath string,
	redactHeadersList,
	redactRequestBodyList, redactResponseBodyList []string,
	errorList []apitoolkit.ATError,
	msgID uuid.UUID,
	parentID *uuid.UUID,
) apitoolkit.Payload

Types

type InstrumentedHttpClient

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

func NewHttpClient

func NewHttpClient(ctx context.Context, client tls_client.HttpClient, apitoolkitClient *apitoolkit.Client) *InstrumentedHttpClient

func (*InstrumentedHttpClient) CloseIdleConnections

func (c *InstrumentedHttpClient) CloseIdleConnections()

func (*InstrumentedHttpClient) Do

func (c *InstrumentedHttpClient) Do(req *fhttp.Request) (res *fhttp.Response, err error)

func (*InstrumentedHttpClient) Get

func (c *InstrumentedHttpClient) Get(url string) (*fhttp.Response, error)

func (*InstrumentedHttpClient) GetCookieJar

func (c *InstrumentedHttpClient) GetCookieJar() fhttp.CookieJar

func (*InstrumentedHttpClient) GetCookies

func (c *InstrumentedHttpClient) GetCookies(u *url.URL) []*fhttp.Cookie

func (*InstrumentedHttpClient) GetFollowRedirect

func (c *InstrumentedHttpClient) GetFollowRedirect() bool

func (*InstrumentedHttpClient) GetProxy

func (c *InstrumentedHttpClient) GetProxy() string

func (*InstrumentedHttpClient) Head

func (c *InstrumentedHttpClient) Head(url string) (*fhttp.Response, error)

func (*InstrumentedHttpClient) Post

func (c *InstrumentedHttpClient) Post(url, contentType string, body io.Reader) (*fhttp.Response, error)

func (*InstrumentedHttpClient) SetCookieJar

func (c *InstrumentedHttpClient) SetCookieJar(jar fhttp.CookieJar)

func (*InstrumentedHttpClient) SetCookies

func (c *InstrumentedHttpClient) SetCookies(u *url.URL, cookies []*fhttp.Cookie)

func (*InstrumentedHttpClient) SetFollowRedirect

func (c *InstrumentedHttpClient) SetFollowRedirect(followRedirect bool)

func (*InstrumentedHttpClient) SetProxy

func (c *InstrumentedHttpClient) SetProxy(proxyUrl string) error