Install Scalyr Agent on Windows

The Scalyr Agent is a daemon to install on each of your servers. It uploads logs and system metrics to the Scalyr servers. This page provides streamlined instructions to get you up and running quickly on Windows systems. For installing on Linux, please see the Linux agent installation instructions.

1. Generate a "Log Write Access" API Key for your account.

2. Download the Windows Installer and run it. It will ask for Administrator privileges to install itself.

3. The agent configuration file agent.json is automatically opened in Notepad at the end of installation. Enter your API key for the "api_key" JSON property.

4. The scalyr-server configuration variable defaults to our US servers at Customers with EU accounts will have to set this variable to by adding the following below the line you updated in step 3:

 "scalyr_server": "",

3. [Optional] You can also update the configuration file to upload logs of your choosing. While the configuration file is still open in Notepad, find the logs section, and insert something like this:

logs: [
    path: "C:\\WebServer\\logs\\access.log",
    attributes: {parser: "accessLog"}

Substitute the path for your web server's access log. Note, you must double any backslashes in the file path, as in the example above.

You can upload any number of log files, of any type; give each file its own entry in the logs list.

The parser property creates a configuration file, accessed from your account, specifying the rules to parse fields from your log messages. Choose a name that describes the log format, using letters, digits, spaces, hyphens, and underscores.

Scalyr includes a suite of standard log parsers such as "accessLog" for standard web access logs. For more information see the Uploading Logs section on the Scalyr Agent page.

You can modify the configuration file later on to add more log entries after the agent has been started. The agent will notice any configuration file changes within 30 seconds without the need for a restart.

4. Save the configuration file.

5. Start the agent, by clicking on the Start the Scalyr Agent shortcut in the Windows Start menu under Scalyr.

This will open a console window with the message "The agent has started" if the agent has been successfully started. You may close the console window at any time; it does not stop the agent.

That's It!

Hopefully, that was easy. If you've had any trouble, please let us know. Otherwise, if this is your first time using Scalyr, this would be an excellent time to head on to the Getting Started guide.

If you're using any log formats other than accessLog, you should first pop over to the Log Parsing page to set up a parser.

For complete documentation, see the agent reference. Here you can learn how to download the agent directly (instead of using our package repository), get tips for installing via a tool like Chef or Puppet, find troubleshooting tips, and more.

Additional options

Changing reported hostname

By default, Scalyr will identify your server by its hostname. If your hostname is something unhelpful like "ip-12-23-34-45", you can specify a different name.