How an instance is organised
The instance
Section titled “The instance”An instance is one installation of Ottertrail, with its own address, such as https://analytics.example.com. The instance holds:
- Your projects.
- The dashboard users: an owner, admins, and members.
- The instance settings: a display name, a timezone, and whether the location data updates itself.
- The notification channels that alerts and storage warnings go to.
The owner and admins open the instance’s Settings from the workspace menu. It has four tabs: General (the name and the timezone) and Location data for the owner, and Storage and Notification channels for the owner and admins. See Storage, Location data, and Notification channels.
The timezone sets where each day starts in every report. Anonymous visitor IDs also change at midnight in this timezone. The owner sets the timezone during setup and can change it later.
Projects
Section titled “Projects”A project is one website or app. Everything that Ottertrail stores belongs to one project: events, errors, replays, traces, logs, metrics, and uptime checks.
Each project has two keys:
| Key | Form | Where it goes | What it allows |
|---|---|---|---|
| Public key | pk_ and 32 hex characters |
In your pages, on the tracker’s script tag | Sending browser events only. It cannot read data. |
| Secret key | sk_ and 32 hex characters |
On your servers and in your build, never in a page | Server-side events, source map uploads, OpenTelemetry data, and user ID signatures |
A project also has a list of allowed hostnames, such as example.com and www.example.com. The instance accepts browser events only from pages on these hostnames. The match is exact: example.com does not allow www.example.com. A new project accepts no browser events until you add its hostnames.
Environments and releases
Section titled “Environments and releases”The same app can run in several places: the live site, a staging site, or a developer’s computer. Each event can name its environment, such as staging, and its release, such as 1.4.2. An event without an environment counts as production. Reports show one environment at a time, so test traffic does not mix into the live numbers.
The tracker sets both with script attributes. See the tracker reference. Servers set them in their OpenTelemetry resource attributes. See Send telemetry.
People
Section titled “People”Nobody can sign up to an instance. The owner creates the first account with a one-time setup link from the server. Other people join by invitation links that an owner or admin makes in the dashboard.
| Role | What it can do |
|---|---|
| Owner | Everything. There is one owner. Only the owner changes the instance settings. |
| Admin | Everything except the instance settings and changes to the owner. Admins see the Storage and Notification channels tabs. |
| Member | Only the projects and areas that an owner or admin gives them. |
A member gets access to each area at a level: none, view, or manage. The areas are web analytics, product analytics, errors, replays, users, monitoring, and uptime and alerts. Members never see project keys, project settings, or the instance settings.
The next pages explain the dashboard, the overview, and project settings.