sealights

README

libbuildpack-sealights

Cloud Foundry Buildpack integrations with Sealights

Bind your application to your Sealights service

1. First step is to create and configure user provided service

   For Linux: cf cups sealights -p '{"token":"ey…"}' For Windows: cf cups sealights -p "{\"token\":\"ey…\"}"

   Note: you can change prameters later with command cf uups sealights -p ...

   Complete list of the prameters currently supported by the buildpack service is:

   {
       "version"               // sealights version. default value: 'latest'
       "verb"                  // allow to specify command for the agent. default value: 'startBackgroundTestListener'
       "customAgentUrl"        // sealights agent will be downloaded from this url if provided
       "customCommand"         // allow to replace application start command
       "proxy"                 // proxy for the agent download client
       "proxyUsername"         // proxy user
       "proxyPassword"         // proxy password
   
       + rest of the parameters will be passed directly to the Sealights agent
   }
   

2. Bind your application to your Sealights service

   cf bind-service [app name] sealights

3. Restage an application to apply the changes

   cf restage [app name]

Logs

You can enable Debug logs level by setting BP_DEBUG env variable:

cf set-env <your-app> BP_DEBUG True

Documentation

Index

• Constants
• func NewHook() libbuildpack.Hook
• type AgentInstaller
  • func NewAgentInstaller(log *libbuildpack.Logger, options *SealightsOptions) *AgentInstaller
  • func (agi *AgentInstaller) InstallAgent(stager *libbuildpack.Stager) (string, string, error)
• type Command
• type Configuration
  • func NewConfiguration(log *libbuildpack.Logger, stager *libbuildpack.Stager) *Configuration
  • func (conf Configuration) UseSealights() bool
• type EnvManager
  • func NewEnvManager(log *libbuildpack.Logger, options *SealightsOptions) *EnvManager
  • func (emng *EnvManager) GetVariables(runtimeDirectory string) map[string]string
  • func (emng *EnvManager) WriteIntoFile(filePath string, envVariables map[string]string) error
• type Launcher
  • func NewLauncher(log *libbuildpack.Logger, options *SealightsOptions, ...) *Launcher
  • func (la *Launcher) ModifyStartParameters(stager *libbuildpack.Stager) error
• type PlatformProfilerParams
• type ReleaseData
• type ReleaseInfo
  • func NewReleaseInfo(buildDirectory string) *ReleaseInfo
  • func (rel *ReleaseInfo) GetStartCommand() string
  • func (rel *ReleaseInfo) SetStartCommand(newCommand string) error
• type SealightsHook
  • func (h *SealightsHook) AfterCompile(stager *libbuildpack.Stager) error
• type SealightsOptions
• type VcapServicesModel

Constants

const AgentDir = "sealights"

const AgentDownloadUrlFormat = "https://agents.sealights.co/dotnetcore/%s/%s"

const DefaultPort = "31031"

const DefaultVersion = "latest"

const DotnetDir = "dotnet-sdk"

const GlobalVariablesFile = "sealights-env.sh"

const LinuxAgentName = "SL.DotNet"

const LinuxPackageDir = "sealights-dotnet-agent-linux-self-contained"

const LinuxPackageName = "sealights-dotnet-agent-linux-self-contained.tar.gz"

const LinuxProfilerId = "{3B1DAA64-89D4-4999-ABF4-6A979B650B7D}"

const LinuxProfilerName = "libSL.DotNet.ProfilerLib.Linux.so"

const ReleaseFileName = "dotnet-core-buildpack-release-step.yml"

const StartCommandType = "web"

const VersionFileName = "version.txt"

const WindowsAgentName = "SL.DotNet.exe"

const WindowsPackageDir = "sealights-dotnet-agent-windows-self-contained"

const WindowsPackageName = "sealights-dotnet-agent-windows-self-contained.zip"

const WindowsProfilerId = "{01CA2C22-DC03-4FF5-8350-59E32A3536BA}"

const WingowsProfilerName32 = "SL.DotNet.ProfilerLib_x86.dll"

const WingowsProfilerName64 = "SL.DotNet.ProfilerLib_x64.dll"

Functions

func NewHook

func NewHook() libbuildpack.Hook

NewHook returns a libbuildpack.Hook instance for integrating with Sealights

Types

type AgentInstaller

type AgentInstaller struct {
	Log                *libbuildpack.Logger
	Options            *SealightsOptions
	MaxDownloadRetries int
}

func NewAgentInstaller

func NewAgentInstaller(log *libbuildpack.Logger, options *SealightsOptions) *AgentInstaller

func (*AgentInstaller) InstallAgent

func (agi *AgentInstaller) InstallAgent(stager *libbuildpack.Stager) (string, string, error)

type Command

type Command interface {
	Execute(string, io.Writer, io.Writer, string, ...string) error
}

Command is an interface around libbuildpack.Command. Represents an executor for external command calls. We have it as an interface so that we can mock it and use in the unit tests.

type Configuration

type Configuration struct {
	Value  *SealightsOptions
	Log    *libbuildpack.Logger
	Stager *libbuildpack.Stager
}

func NewConfiguration

func NewConfiguration(log *libbuildpack.Logger, stager *libbuildpack.Stager) *Configuration

func (Configuration) UseSealights

func (conf Configuration) UseSealights() bool

type EnvManager

type EnvManager struct {
	Options *SealightsOptions
	Log     *libbuildpack.Logger
}

func NewEnvManager

func NewEnvManager(log *libbuildpack.Logger, options *SealightsOptions) *EnvManager

func (*EnvManager) GetVariables

func (emng *EnvManager) GetVariables(runtimeDirectory string) map[string]string

func (*EnvManager) WriteIntoFile

func (emng *EnvManager) WriteIntoFile(filePath string, envVariables map[string]string) error

type Launcher

type Launcher struct {
	Log                *libbuildpack.Logger
	Options            *SealightsOptions
	AgentDirAbsolute   string
	AgentDirForRuntime string
	Stager             *libbuildpack.Stager
}

func NewLauncher

func NewLauncher(log *libbuildpack.Logger, options *SealightsOptions, agentInstallationDir string, stager *libbuildpack.Stager) *Launcher

func (*Launcher) ModifyStartParameters

func (la *Launcher) ModifyStartParameters(stager *libbuildpack.Stager) error

type PlatformProfilerParams

type PlatformProfilerParams struct {
	Name_32 string
	Name_64 string
	Id      string
}

type ReleaseData

type ReleaseData struct {
	DefaultProcessTypes map[string]string `yaml:"default_process_types"`
}

file format: default_process_types:

web: cd ${DEPS_DIR}/0/dotnet_publish && exec ./app --server.urls http://0.0.0.0:${PORT}

type ReleaseInfo

type ReleaseInfo struct {
	Data     ReleaseData
	FilePath string
}

func NewReleaseInfo

func NewReleaseInfo(buildDirectory string) *ReleaseInfo

func (*ReleaseInfo) GetStartCommand

func (rel *ReleaseInfo) GetStartCommand() string

func (*ReleaseInfo) SetStartCommand

func (rel *ReleaseInfo) SetStartCommand(newCommand string) error

type SealightsHook

type SealightsHook struct {
	libbuildpack.DefaultHook
	Log     *libbuildpack.Logger
	Command Command
}

SealightsHook implements libbuildpack.Hook. It downloads and install the Sealights OneAgent.

func (*SealightsHook) AfterCompile

func (h *SealightsHook) AfterCompile(stager *libbuildpack.Stager) error

AfterCompile downloads and installs the Sealights agent, and modify application start command

type SealightsOptions

type SealightsOptions struct {
	Version        string
	Verb           string
	CustomAgentUrl string
	CustomCommand  string
	Proxy          string
	ProxyUsername  string
	ProxyPassword  string
	UsePic         bool
	SlArguments    map[string]string
	SlEnvironment  map[string]string
}

type VcapServicesModel

type VcapServicesModel struct {
	Sealights SealightsOptions
}