Installation

This section will help you install the logs command-line tool, and install an instance of Apex Logs to your Google Cloud account.

Installing the command-line

The logs command-line tool is used to manage Apex Logs installations, known as “instances”, and to search log events from the terminal.

You can manually install binaries from GitHub Releases, or install with the following command:

curl -sf https://logs.apex.sh/install | sh

By default the command is installed to /usr/local/bin, to specify a directory use BINDIR. Here’s an example installing to the current directory:

curl -sf https://logs.apex.sh/install | BINDIR=. sh

Later when you want to update to the latest version use the following command:

logs upgrade

Creating a Google Cloud project

Next you’ll need to create a Google Cloud project to hold your Apex Logs installation by visiting https://console.cloud.google.com/projectcreate.

Create a Google Cloud project

Google Cloud uses projects to isolate resources & billing used for a particular application, in this case Apex Logs, this will allow you to delete the project later if you choose to no longer use it without impacting any other applications.

Installing an instance

Now that you have a Google Cloud project for your instance, run the following command to install Apex Logs:

logs instance install

The first time you run the command you’ll be prompted to sign-in to your Apex Software account, used for billing and gaining access to the Apex Logs user interface.

Signing in to Apex Software

You can create a new team, or use the default “Personal” team which can be renamed later.

Selecting a team

Next choose the Google Cloud project you created for the Apex Logs installation:

Choosing a project

Finally select the region for your instance. The user interface and API for ingesting logs will be located here so you’ll want to consider the location of your servers.

Choosing a region for the API

After a few minutes your instance of Apex Logs will be ready to go! Paste the link into your browser to view the application.

Installation complete

Subscribe your team to a plan and you’re ready to use Apex Logs! At any time you can invite team members so they can view the interface and logs.

Subscribing to Apex Logs

Trials without a credit card are planned, however, Apex Logs is billed for each megabyte ingested per day (rounded), so you can effectively try Apex Logs for free if your usage is low.

Updating an instance

Update the logs CLI:

logs upgrade

Then update the instance:

logs instance update

Or both in one command:

logs upgrade && logs instance update

You can also specify a particular version for your instance:

logs instance update --target v1.2.0

Installing as a desktop application

Optionally you can install the Apex Logs web application on the desktop by clicking the “plus” icon in the Google Chrome address bar. Chrome will provide you with an “Apex Logs” application which behaves like a regular desktop app.

Install as a PWA

There’s no need to update the PWA, it behaves like a regular web application and wil refresh each time you launch it or press cmd+r.