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. Add the following to your settings.json:

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

Then run your app with settings:

meteor run --settings settings.json

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 in settings. 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​

We recommend storing your API key securely:

Development (settings.json)​

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

Production​

Set the API key in your deployment environment:

# Linux/macOS
export SKYSIGNAL_API_KEY=sk_live_xxxxxxxxxxxx

# Or use Meteor settings in production
# Galaxy: Set in app settings dashboard
# Docker: Pass settings.json as environment

For production with settings:

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

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​