Skip to main content

Installation

Learn how to install the SkySignal agent in your Meteor.js application.

Package Installation​

Add the SkySignal agent package to your Meteor project:

meteor add skysignal:agent

Basic Setup​

The agent auto-starts when it finds your API key in Meteor settings or the SKYSIGNAL_API_KEY environment variable.

Option A: Meteor Settings​

Add the following to your settings.json:

{
  "skysignal": {
    "apiKey": "sk_live_xxxxxxxxxxxx"
  }
}

Then run your app with settings:

meteor run --settings settings.json

Option B: Environment Variable​

SKYSIGNAL_API_KEY=sk_live_xxxxxxxxxxxx meteor run

Option C: Both​

Use an env var for the API key and a settings file for tuning:

SKYSIGNAL_API_KEY=sk_live_xxxxxxxxxxxx meteor run --settings settings.json

When both are present, Meteor settings take priority over environment variables.

That's it! The agent will automatically start monitoring your application.

Zero-code setup

Unlike npm packages, the Meteor package automatically initializes when you provide your API key. No code changes required!

Manual Configuration (Optional)​

If you need more control, you can configure the agent manually in your server code:

import { SkySignalAgent } from 'meteor/skysignal:agent';

// Configure with custom options
SkySignalAgent.configure({
  apiKey: process.env.SKYSIGNAL_API_KEY,
  appName: 'my-meteor-app',
  debug: true,
});

// Start the agent
SkySignalAgent.start();
Server-side only

The SkySignal agent runs on the server side only. Client-side monitoring is handled separately via RUM (Real User Monitoring).

Environment Variables​

The agent supports configuration via environment variables, which is the recommended approach for production secrets like API keys.

Development​

Use a settings file for convenience:

{
  "skysignal": {
    "apiKey": "sk_dev_xxxxxxxxxxxx",
    "debug": true
  }
}

Production​

Set the API key via environment variable to keep it out of config files:

# The agent auto-starts from this env var alone
export SKYSIGNAL_API_KEY=sk_live_xxxxxxxxxxxx

# Or combine with a settings file for other options
SKYSIGNAL_API_KEY=sk_live_xxxxxxxxxxxx meteor run --settings settings-production.json

Platform-specific examples:

# Galaxy: Set in your app settings or deploy command
meteor deploy myapp.meteorapp.com --settings settings-production.json

# Docker: Pass as environment variable
docker run -e SKYSIGNAL_API_KEY=sk_live_xxxxxxxxxxxx my-meteor-app

# Docker Compose
# environment:
#   - SKYSIGNAL_API_KEY=sk_live_xxxxxxxxxxxx
#   - SKYSIGNAL_DEBUG=false

All server-side configuration options have corresponding SKYSIGNAL_* environment variables. See the Configuration Guide for the complete reference.

Verification​

After installation, verify the agent is working:

  1. Start your Meteor application with settings
  2. Check the server console for: [SkySignal] Agent started - host: your-hostname
  3. Make a Method call or navigate your app
  4. Check your SkySignal dashboard for incoming data

Debug Mode​

Enable debug logging to troubleshoot issues:

{
  "skysignal": {
    "apiKey": "sk_live_xxxxxxxxxxxx",
    "debug": true
  }
}

Updating the Agent​

To update to the latest version:

meteor update skysignal:agent

Check the changelog for breaking changes before updating in production.

Uninstalling​

To remove the SkySignal agent:

  1. Remove the skysignal configuration from your settings.json
  2. Remove the package:
meteor remove skysignal:agent

Next Steps​