-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
13 changed files
with
973 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| NGINX INSTALLER | ||
| =============== | ||
| This folder contains the necessary components to install the NGINX module. | ||
| It consists of an sh script, plus a go binary (configurator) that performs the actual installation. | ||
| Running this installer results in the NGINX module being installed locally. | ||
|
|
||
| Shell script | ||
| ------------ | ||
| Verifies connectivity to the Datadog Agent. Detects the architecture, downloads | ||
| the Configurator for the specific architecture and invokes it forwarding all the | ||
| parameters plus the architecture. | ||
|
|
||
| Configurator | ||
| ------------ | ||
| Does the bulk of the installation. | ||
| 1. Validates parameters | ||
| 2. Validates NGINX installation and version | ||
| 3. Downloads the NGINX module | ||
| 4. Makes neccessary config modifications | ||
| 5. Validates the modified configurations. | ||
|
|
||
| Local Testing | ||
| ------------- | ||
| 1. Compile the go binary | ||
| ```bash | ||
| env GOOS=linux go -C configurator build -o ../nginx-configurator | ||
| ``` | ||
| 2. Start docker compose with the docker-compose file provided. It boots up an NGINX | ||
| instance and a Datadog Agent instance with connectivity to each other. | ||
| ```bash | ||
| DD_API_KEY=<YOUR_API_KEY> docker compose -f test/docker-compose.yml up -d | ||
| ``` | ||
| 3. Run the installer | ||
| ```bash | ||
| docker compose -f test/docker-compose.yml exec nginx bash -c "cd /installer && sh install-nginx-datadog.sh --appId 123 --site datadoghq.com --clientToken abcdef --sessionSampleRate 50 --sessionReplaySampleRate 50 --agentUri http://datadog-agent:8126" | ||
| ``` | ||
|
|
||
| Currently, the latest release doesn't yet support rum injection, so expect a message | ||
| showing an error when validating the final NGINX configuration `unknown directive | ||
| "datadog_rum" in /etc/nginx/nginx.conf` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "flag" | ||
| "fmt" | ||
| "os" | ||
|
|
||
| log "github.com/sirupsen/logrus" | ||
| ) | ||
|
|
||
| var InstallerVersion = "0.1.0" | ||
|
|
||
| func validateInput(appID, site, clientToken, arch string, sessionSampleRate, sessionReplaySampleRate int) error { | ||
|
|
||
| log.Debug("Validating input arguments") | ||
|
|
||
| if appID == "" { | ||
| return NewInstallerError(ArgumentError, fmt.Errorf("--appId is required")) | ||
| } | ||
| if site == "" { | ||
| return NewInstallerError(ArgumentError, fmt.Errorf("--site is required")) | ||
| } | ||
| if clientToken == "" { | ||
| return NewInstallerError(ArgumentError, fmt.Errorf("--clientToken is required")) | ||
| } | ||
| if sessionSampleRate < 0 || sessionSampleRate > 100 { | ||
| return NewInstallerError(ArgumentError, fmt.Errorf("sessionSampleRate is required and must be between 0 and 100")) | ||
| } | ||
| if sessionReplaySampleRate < 0 || sessionReplaySampleRate > 100 { | ||
| return NewInstallerError(ArgumentError, fmt.Errorf("sessionReplaySampleRate is required and must be between 0 and 100")) | ||
| } | ||
| if arch != "amd64" && arch != "arm64" { | ||
| return NewInstallerError(ArgumentError, fmt.Errorf("arch must be either 'amd64' or 'arm64'")) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func handleError(err error) { | ||
| // TODO: Send telemetry | ||
|
|
||
| log.Error(err) | ||
|
|
||
| os.Exit(1) | ||
| } | ||
|
|
||
| func main() { | ||
| appID := flag.String("appId", "", "Application ID") | ||
| site := flag.String("site", "", "Site") | ||
| clientToken := flag.String("clientToken", "", "Client Token") | ||
| sessionSampleRate := flag.Int("sessionSampleRate", -1, "Session Sample Rate (0-100)") | ||
| sessionReplaySampleRate := flag.Int("sessionReplaySampleRate", -1, "Session Replay Sample Rate (0-100)") | ||
| arch := flag.String("arch", "", "Architecture (amd64 or arm64)") | ||
| agentUri := flag.String("agentUri", "http://localhost:8126", "Datadog Agent URI") | ||
| skipVerify := flag.Bool("skipVerify", false, "Skip verifying downloads") | ||
| verbose := flag.Bool("verbose", false, "Verbose output") | ||
| dryRun := flag.Bool("dryRun", false, "Dry run (no changes made)") | ||
|
|
||
| flag.Parse() | ||
|
|
||
| if *verbose { | ||
| log.SetLevel(log.DebugLevel) | ||
| log.Debug("Verbose output enabled") | ||
| } else { | ||
| log.SetLevel(log.InfoLevel) | ||
| } | ||
|
|
||
| log.Info("Starting installer version ", InstallerVersion) | ||
|
|
||
| if *dryRun { | ||
| log.Info("Dry run enabled. No changes will be made.") | ||
| } | ||
|
|
||
| if err := validateInput(*appID, *site, *clientToken, *arch, *sessionSampleRate, *sessionReplaySampleRate); err != nil { | ||
| handleError(err) | ||
| } | ||
|
|
||
| var configurator ProxyConfigurator = &NginxConfigurator{} | ||
|
|
||
| if err := configurator.VerifyRequirements(); err != nil { | ||
| handleError(err) | ||
| } | ||
|
|
||
| if err := configurator.DownloadAndInstallModule(*arch, *skipVerify); err != nil { | ||
| handleError(err) | ||
| } | ||
|
|
||
| if err := configurator.ModifyConfig(*appID, *site, *clientToken, *agentUri, *sessionSampleRate, *sessionReplaySampleRate, *dryRun); err != nil { | ||
| handleError(err) | ||
| } | ||
|
|
||
| if !*dryRun { | ||
| if err := configurator.ValidateConfig(); err != nil { | ||
| handleError(err) | ||
| } | ||
|
|
||
| log.Info("Datadog NGINX module has been successfully installed and configured. Please restart NGINX for the changes to take effect") | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| package main | ||
|
|
||
| import "fmt" | ||
|
|
||
| type ErrorType int | ||
|
|
||
| const ( | ||
| UnexpectedError ErrorType = iota | ||
| ArgumentError | ||
| InternalError | ||
| NginxError | ||
| TelemetryError | ||
| ) | ||
|
|
||
| func (e ErrorType) String() string { | ||
| switch e { | ||
| case UnexpectedError: | ||
| return "UnexpectedError" | ||
| case ArgumentError: | ||
| return "ArgumentError" | ||
| case InternalError: | ||
| return "InternalError" | ||
| case NginxError: | ||
| return "NginxError" | ||
| case TelemetryError: | ||
| return "TelemetryError" | ||
| default: | ||
| return fmt.Sprintf("%d", int(e)) | ||
| } | ||
| } | ||
|
|
||
| func NewInstallerError(errorType ErrorType, err error) *InstallerError { | ||
| return &InstallerError{ | ||
| ErrorType: errorType, | ||
| Err: err, | ||
| } | ||
| } | ||
|
|
||
| type InstallerError struct { | ||
| ErrorType ErrorType | ||
| Err error | ||
| } | ||
|
|
||
| func (m *InstallerError) Error() string { | ||
| return fmt.Sprintf("%s: %v", m.ErrorType, m.Err) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| module github.com/DataDog/nginx-datadog/installer | ||
|
|
||
| go 1.21.0 | ||
|
|
||
| require ( | ||
| github.com/google/go-github v17.0.0+incompatible | ||
| github.com/google/uuid v1.6.0 | ||
| github.com/sirupsen/logrus v1.9.3 | ||
| ) | ||
|
|
||
| require ( | ||
| github.com/google/go-querystring v1.1.0 // indirect | ||
| github.com/stretchr/testify v1.9.0 // indirect | ||
| golang.org/x/sys v0.22.0 // indirect | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= | ||
| github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= | ||
| github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= | ||
| github.com/google/go-cmp v0.5.2 h1:X2ev0eStA3AbceY54o37/0PQ/UWqKEiiO2dKL5OPaFM= | ||
| github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= | ||
| github.com/google/go-github v17.0.0+incompatible h1:N0LgJ1j65A7kfXrZnUDaYCs/Sf4rEjNlfyDHW9dolSY= | ||
| github.com/google/go-github v17.0.0+incompatible/go.mod h1:zLgOLi98H3fifZn+44m+umXrS52loVEgC2AApnigrVQ= | ||
| github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD/fhyJ8= | ||
| github.com/google/go-querystring v1.1.0/go.mod h1:Kcdr2DB4koayq7X8pmAG4sNG59So17icRSOU623lUBU= | ||
| github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= | ||
| github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= | ||
| github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= | ||
| github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= | ||
| github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ= | ||
| github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ= | ||
| github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= | ||
| github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= | ||
| github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg= | ||
| github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= | ||
| golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= | ||
| golang.org/x/sys v0.22.0 h1:RI27ohtqKCnwULzJLqkv897zojh5/DwS/ENaMzUOaWI= | ||
| golang.org/x/sys v0.22.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= | ||
| golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= | ||
| gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= | ||
| gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= | ||
| gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= | ||
| gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= |
Oops, something went wrong.