README
¶
libbuildpack-dynatrace
Base Library for Go-based Cloud Foundry Buildpack integrations with Dynatrace.
Summary
The library provides the Hook struct that implements the libbuildpack.Hook interface that it's requested by the CF Buildpacks.
On the buildpacks, you're expected to provide a hook through a init() function where you can register such hook implementation. For example, a simple implementation could be,
import (
"github.com/cloudfoundry/libbuildpack"
"github.com/Dynatrace/libbuildpack-dynatrace"
)
func init() {
libbuildpack.AddHook(dynatrace.NewHook("nodejs", "process"))
}
Configuration
The Hook will look for credentials in the configurations for existing services (which is represented in the runtime as the VCAP_SERVICES environment variable in JSON format.) We look for service names having the 'dynatrace' substring.
We support the following configuration fields,
| Key | Type | Description | Required | Default |
|---|---|---|---|---|
| environmentid | string | The ID for the Dynatrace environment. | Yes | N/A |
| apitoken | string | The API Token for the Dynatrace environment. | Yes | N/A |
| apiurl | string | Overrides the default Dynatrace API URL to connect to. | No | Default API URL |
| skiperrors | boolean | If true, the deployment doesn't fail if the Dynatrace agent download fails. | No | false |
| networkzone | string | If set, agent is configured to choose communication endpoints located at the field's value. | No | empty |
| enablefips | boolean | If true, the FIPS 140-2 mode is enabled | No | false |
For example,
cf create-user-provided-service dynatrace -p '{"environmentid":"...","apitoken":"..."}'
See more at the documentation for cf create-user-provided-service.
We also support standard Dynatrace environment variables.
Requirements
- Go 1.11
- Linux to run the tests.
Development
You can download or clone the repository.
You can run tests through,
go test
If you modify/add interfaces, you may need to regenerate the mocks. For this you need gomock:
# To download Gomock
go get github.com/golang/mock/gomock
go install github.com/golang/mock/mockgen
# To generate the mocks
go generate
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewHook ¶
func NewHook(technologies ...string) libbuildpack.Hook
NewHook returns a libbuildpack.Hook instance for integrating monitoring with Dynatrace. The technology names for the agents to download can be set as parameters.
Types ¶
type Command ¶
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 Hook ¶
type Hook struct {
libbuildpack.DefaultHook
Log *libbuildpack.Logger
Command Command
// IncludeTechnologies is used to indicate the technologies we want to download agents for.
IncludeTechnologies []string
// MaxDownloadRetries is the maximum number of retries the hook will try to download the agent if they fail.
MaxDownloadRetries int
}
Hook implements libbuildpack.Hook. It downloads and install the Dynatrace OneAgent.
func (*Hook) AfterCompile ¶
func (h *Hook) AfterCompile(stager *libbuildpack.Stager) error
AfterCompile downloads and installs the Dynatrace agent.
Source Files