Brightspot CMS Developer Guide

Activity logs

The key cms/tool/isActivityLogged records events within Brightspot. The events are sent to the Tomcat log file catalina.out.

The following table describes the attributes associated with this key.

Valid values
Key for toggling on or off activity logging.
Type of the value.
Indicates if logging is enabled.
truefalse (default)

The following snippet records events in the Tomcat log file.

<Environment name="cms/tool/isActivityLogged" type="java.lang.Boolean" value="true" override="false"/>

Brightspot's standard configuration provides entries for login/logout and publication events. The following table describes the fields in each entry.

Login/logout events
Publication events
  • Timestamp
  • Log level (INFO)
  • Tomcat thread
  • Java class triggering the entry
  • Activity type (ToolAuthentication)
  • Key-value array:

    • User's ID
    • Login status (success or fail)
    • Server's domain
    • User's IP address
  • Timestamp
  • Log level (INFO)
  • Tomcat thread
  • Java class triggering the entry
  • Activity type (Deleted, Unscheduled, Saved draft, Saved new draft, Scheduled, Published, Restored, Created new, Saved, Archived, Merged, Transitioned Workflow)
  • Content type
  • Key-value array:

    • Item's UUID
    • Item's title
  • Key-value array:

    • Name of user performing the activity
    • User's UUID

The following log entry describes a successful login event.
04-Feb-2021 16:31:41 INFO [http-nio-8080-exec-9] com.psddev.cms.tool.ToolActivity ToolAuthentication [, status:success, domain:, ipAddress:]

The following log entry describes a publication event for an article.
04-Feb-2021 16:36:24 INFO [http-nio-8080-exec-9] com.psddev.cms.tool.ToolActivity Published Article [id: 00000177-6ef9-decc-aff7-fefb03f10001, label: Washing iPhone ear buds] [user name: joe, id: 00000177-68da-d640-a9f7-69db41290000]

Previous Topic
Integrating AWS Services
Next Topic
Was this topic helpful?
Thanks for your feedback.
Our robust, flexible Design System provides hundreds of pre-built components you can use to build the presentation layer of your dreams.

Asset types
Module types
Page types
Brightspot is packaged with content types that get you up and running in a matter of days, including assets, modules and landing pages.

Content types
Landing pages
Everything you need to know when creating, managing, and administering content within Brightspot CMS.

Admin configurations
A guide for installing, supporting, extending, modifying and administering code on the Brightspot platform.

Field types
Content modeling
Rich-text elements
A guide to configuring Brightspot's library of integrations, including pre-built options and developer-configured extensions.

Google Analytics
Apple News