Skip to content

Getting Started

Brian Harrington edited this page Jun 6, 2017 · 27 revisions

The instructions on this page are for quickly getting a sample backend server running on a local machine. For other common tasks see:

Run a Demo Instance

Prerequisites

  • These instructions assume a unix based machine with curl. Other systems may work, but have not been tried.
  • Java 8 or higher is required.

To quickly run a version with some synthetic sample data:

$ curl -LO https://github.com/Netflix/atlas/releases/download/v1.5.3/atlas-1.5.3-standalone.jar
$ java -jar atlas-1.5.3-standalone.jar

Explore Available Tags

The tags API is used to explore available tags and the relationships between them.

# show all tags
$ curl -s 'http://localhost:7101/api/v1/tags'

# show all values of the name, nf.app and type tags
$ curl -s 'http://localhost:7101/api/v1/tags/name'
$ curl -s 'http://localhost:7101/api/v1/tags/nf.app'
$ curl -s 'http://localhost:7101/api/v1/tags/type'

# show all name tags that also have the type tag
$ curl -s 'http://localhost:7101/api/v1/tags/name?q=type,:has'

# show all name tags that have an nf.app tag with a value of nccp
$ curl -s 'http://localhost:7101/api/v1/tags/name?q=nf.app,nccp,:eq'

Generate Graphs

These graph API URLs show off a couple of the capabilities of the Atlas backend. See the Examples page for more detailed use cases.

# graph all metrics with a name tag value of ssCpuUser, using an :avg aggregation
$ curl -Lo graph.png 'http://localhost:7101/api/v1/graph?q=name,ssCpuUser,:eq,:avg'

# duplicate the ssCpuUser signal, check if it is greater than 22.8 and display the result as a vertical span with 30% alpha
$ curl -Lo graph.png 'http://localhost:7101/api/v1/graph?q=name,ssCpuUser,:eq,:avg,:dup,22.8,:gt,:vspan,30,:alpha'

Running Demo with Memory Storage

Run an instance with a configuration to use the memory storage:

$ curl -Lo memory.conf https://raw.githubusercontent.com/Netflix/atlas/v1.5.x/conf/memory.conf
$ java -jar atlas-1.5.3-standalone.jar memory.conf

Now we can send some data to it. To quickly get started there is a sample script to send in some data:

$ curl -Lo publish-test.sh https://raw.githubusercontent.com/Netflix/atlas/v1.5.x/scripts/publish-test.sh
$ chmod 755 publish-test.sh
$ ./publish-test.sh

Then view the data in a web browser:

$ open 'http://localhost:7101/api/v1/graph?q=name,randomValue,:eq,:sum,(,name,),:by'
Clone this wiki locally
You can’t perform that action at this time.