Work with ArcGIS Notebook Server logs

ArcGIS Notebook Server records all events that occur in a site, and any errors associated with those events, using logs. These logs are available to site administrators.

Logs are an important tool for monitoring and troubleshooting problems with your ArcGIS Notebook Server site. Information provided by logs can help you identify errors and provide context on how to address problems and resolve errors. The logs also serve as a system of record for events that occur in your site.

For example, the following types of events are recorded in logs:

• Installation and upgrade events, such as software authorization and site creation
• The opening and closing of ArcGIS Notebooks
• Clean-up tasks performed by the site
• Site management events performed by administrators, such as adding or removing notebook runtimes, creating server directories, or configuring security settings.
• Security events, such as users logging in to the site or the import and export of SSL certificates.

Some events are not recorded in the ArcGIS Notebook Server logs. This includes federating the site with a portal. Events that occur within ArcGIS Notebooks—adding content, running cells, and so on—are not recorded. Neither are events that occur within your machine's Docker containers; to view container-specific logs, see View Docker container logs below.

Available log levels

Each log carries a logging level of detail, which can be one of the following, in order from the least detailed to most detailed:

• Severe—Serious problems that require immediate attention.
• Warning—Moderate problems that require attention.
• Info—Common administrative messages of the Notebook Server site, including messages about service creation and startup.
• Fine—Common messages from use of the server, like names of operation requests received.
• Verbose—Messages providing more detail about how the server fulfills an operation.
• Debug—Highly verbose messages designed for developers and support technicians who want to obtain a better understanding of the server's state when troubleshooting. Not recommended for use in production systems due to the amount of logs created.

In the ArcGIS Notebook Server Administrator Directory, you can specify the most detailed log level to be created. For example, if you set the level to Fine, your server site will log messages at the Severe, Warning, Info, and Fine levels of detail.

Query log settings in Manager

Starting at 10.8, ArcGIS Notebook Server Manager includes a Logs page. On this page, you can query all logs for your ArcGIS Notebook Server site.

1. Sign in to your ArcGIS Enterprise portal as an administrator and open ArcGIS Notebook Server Manager.
2. Open the Logs page.
3. The query filter parameters are at the top of the page. Use any of the parameters to limit or expand your search.

   • Log level—The minimum log level for which to query (see the above section). It returns only records with a log level at or more severe than this level. The default level is WARNING.
   • Log time—The duration of time to search for logs. You can limit a query to the last 15 minutes, last hour, last six or 24 hours, last week, or last 30 days, or show all logs since the site was created.

     Tip:

     Use the Administrator Directory to query logs if you want to specify an end time different from the present, such as logs between three and two days ago.

   • Machine—Limit the query to logs from one of your ArcGIS Notebook Server machines or show logs from all machines.
   • Log codes—One or a range of log codes assigned to a log message. If left blank, all log codes are shown.
   • Users—The user name of one or more users (separated by commas) whose related logs to query. Some log messages are related to a specific user's action.

4. Click Search to run the query. All logs matching your query parameters are shown in the resulting table.

Change log settings in Manager

You can also use ArcGIS Notebook Server Manager to change the log settings for your site.

1. Sign in to your ArcGIS Enterprise portal as an administrator and open ArcGIS Notebook Server Manager.
2. Open the Settings page and click Logs.
3. You can change the following settings:

   • Log directory—The disk location of your logs directory. If you have multiple machines in your site, ensure that this path is a UNC share.
   • Log level—The most detailed log level that your site will write. If set to FINE, for example, your site does not keep logs at the VERBOSE or DEBUG levels.
   • Days to keep logs—The number of days after which log messages are deleted. Consider the memory available in your logs directory's drive, as well as the Log level setting you've chosen and the level of activity on your site. For example, if you change the log level to begin writing at a more detailed level, you may need to decrease the number of days logs are kept.

4. Click Save to confirm your changes.

Query server logs in the Administrator Directory

Use the ArcGIS Notebook Server Administrator Directory to query, view, configure, and delete server logs.

To access the logs, follow these steps:

1. Sign in to the Administrator Directory. The URL is formatted https://notebookserver.domain.com:11443/arcgis/adminor https://notebookserver.domain.com/<webadaptorname>/admin.
2. Click Logs > Query to query and review current logs. Use the filter controls on the page to help you narrow events by categories such as time period or logging level.
3. Click Logs > Settings to manage log settings, such as the default logging level (as explained above), the duration for which logs are kept on disk, and the location to which logs are written.
4. Click Clean Logs to delete all of your log files from the ArcGIS Notebook Server site.

View Docker container logs with ArcGIS Notebook Server Manager

You can view logs specific to your site's Docker containers using ArcGIS Notebook Server Manager.

1. Sign into your portal's ArcGIS Notebook Server Manager as an administrator. The URL is formatted https://webadaptorhost.domain.com/webadaptorname/home/notebook/manager.html.
2. Navigate to the Containers tab.
3. Click the View logs button to view the container logs of the chosen machine.

View Docker container logs with the Docker command line

You can view logs specific to your site's Docker containers using the Docker command line interface as follows.

1. Sign in to the Administrator Directory. The URL is formatted https://notebookserver.domain.com:11443/arcgis/admin or https://notebookserver.domain.com/<webadaptorname>/admin.
2. Browse to System > Containers. Locate the container whose logs you want to view, and click its ID.
3. Open the JSON view of the container's info page by adding ?f=pjson to its URL, so that the URL format is https://notebookserver.arcgis.com/<webadaptorname>/admin/system/containers/<container>?f=pjson.
4. Locate the container's containerId and record its value.
5. Open a terminal as a user with Docker privileges.
6. Run the command docker logs <containerId> using the value you recorded. This will return the Docker logs specific to that container.