splunk-cloud-sdk-go

Splunk Cloud Services SDK for Go

The Splunk Cloud Services software development kit (SDK) for Go contains library code and examples to enable you to build apps using the Splunk Cloud Services with the Go programming language.

To use Splunk Cloud Services SDKs, you must be included in the Splunk Investigate Beta Program. Sign up here: https://si.scp.splunk.com/.

Splunk Cloud Services CLI

Splunk Cloud Services CLI, scloud, is a command-line tool for developers to make API calls to Splunk Cloud Services.

For more information about Splunk Cloud Services CLI see the README.

Terms of Service (TOS)

Log in to Splunk Investigate and accept the Terms of Service when prompted.

Get started

Install Go and Go tools

1. Install Go 1.11 or later from the Getting Started page on the Go Programmming Language website.

2. Install recommended tools for Go by running the following commands:

   $ go get golang.org/x/lint/golint
   $ go get -u golang.org/x/tools/cmd/goimports
   

Initialize your project

Initialize your project using Go modules for dependency support. Your project can be located outside of the $GOPATH/src directory. For more about modules, see Go 1.11 Modules on the GitHub website.

1. If your project is within your $GOPATH, set GO111MODULE=on in your environment variables.

2. Initialize your project by running the following commands, but replace the <github.com/example/myproject> path with your Git host, organization, user name, and project name as appropriate:

   $ mkdir myproject && cd myproject
   $ go mod init <github.com/example/myproject>
   

3. Create a main.go file within your project directory containing the following code:

   package main
   
   import (
       "fmt"
       "os"
   
       "github.com/splunk/splunk-cloud-sdk-go/sdk"
       "github.com/splunk/splunk-cloud-sdk-go/services"
       "github.com/splunk/splunk-cloud-sdk-go/services/identity"
   )
   
   func main() {
       checkForTenantToken()
       // Initialize the client
       client, err := sdk.NewClient(&services.Config{
           Token:  os.Getenv("BEARER_TOKEN"),
           Tenant: os.Getenv("TENANT"),
       })
       exitOnErr(err)
       // Validate access to Splunk Cloud Services and tenant
       query := identity.ValidateTokenQueryParams{Include: []string{"principal", "tenant"}}
       info, err := client.IdentityService.ValidateToken(&query)
       exitOnErr(err)
       fmt.Println("name: " + info.Name)
       fmt.Println("principal name: " + info.Principal.Name)
       fmt.Println("tenant name: " + info.Tenant.Name)
   }
   
   func exitOnErr(err error) {
       if err != nil {
           fmt.Println(err)
           os.Exit(1)
       }
   }
   
   func checkForTenantToken() {
       if os.Getenv("BEARER_TOKEN") == "" {
           exitOnErr(fmt.Errorf("$BEARER_TOKEN must be set"))
       }
       if os.Getenv("TENANT") == "" {
           exitOnErr(fmt.Errorf("$TENANT must be set"))
       }
   }
   

4. Set your access token and tenant.

   • Retrieve your access token from the Splunk Developer Portal.

   • List your tenants using the following REST command, replacing <accessToken> with your access token:

     curl -X GET "https://api.scp.splunk.com/system/identity/v2beta1/tenants" \
     -H "Authorization: Bearer <accessToken>"
     

   • Run the following command, replacing <accessToken> and <tenant> with your values:

     $ export BEARER_TOKEN=<accessToken>
     $ export TENANT=<tenant>
     

5. Build and run your project by running the following commands, where <project> is the name of your project, and <me@example.com> is your user name:

   $ go build
   $ ./<project>
   name: <me@example.com>
   principal name: <me@example.com>
   tenant name: <mytenant>
   

Documentation

For general documentation, see the Splunk Developer Portal.

For reference documentation, see the Splunk Cloud Services SDK for Go API Reference.

Contributing

Do not directly edit any source file with _generated in the name because that file was generated from service specifications.

Contact

If you have questions, reach out to us on Slack in the #sdc channel or email us at devinfo@splunk.com.