Customer Token

What is it?

We have a torrent of logs coming at us from all of our clients all the time. So how do we differentiate your logs from everyone else’s? Our answer is a universally unique identifier we call the customer token. Upon account set-up we generate a customer token for you. The customer token is an alpha-numeric string that needs to be included with each log event. Generally speaking, you will continue to use that token throughout the term of your account for all of your logs. The token is used when you send in log data, but isn’t needed when data is retrieved (instead, use your account username & password).

Where is it?

After you set-up your account you can see your customer token by going to the “Source Setup” section and the “Customer Tokens” subsection. You can click the copy button to copy it to your clipboard, and then paste it into your source configuration.

customer_tokens

Syslog Usage

The customer token must be provided within the Structured Data section of your syslog header. Here’s an example header:

syslog_header_example

For more information on templates for your specific syslog version, check out logging from Unix or logging from Windows.

HTTP Usage

The customer token must be provided within the URL of your request. Here’s an example:

HTTP_endpoint

For more information on sending log events over our API, check out our API docs.

Customer Token Management

Adding a description

You can add a label of your choosing to your customer token by editing the description. This label won’t change the token itself and you will need the actual token if you need to set up new sources.

Retire a customer token

It is possible to permanently retire a customer token. You may want to do this if you have had a security breach that would require reassigning a token. Retired tokens are not removed from our system, but cannot be used again once retired. To retire a token, go to the “Customer Tokens” screen and click the “X”. There is generally a short delay between when a token is retired and when we stop accepting data with that token ID.

Note: You must always have at least one active token, but no more than two.

Using multiple Customer Tokens

Source Groups should be used to categorize and organize logs from your infrastructure. Customer Tokens aren’t available within the search interface. However, it is possible to maintain multiple customer tokens to assign to various groups of logs, e.g. public client-based log data vs. private syslog.

If you’re worried that your customer token has been compromised, it’s simple to generate a new token and retire the old. Create a new token by clicking on the “Add New” button in the “Customer Tokens” screen. A new token will be generated.

Note: We have a limit of two customer tokens per account.

Thanks for the feedback! We'll use it to improve our support documentation.


Top