Starting in version 2.2.0, the health and status of vital WorkPoint 365 jobs and processes can now be monitored using event logging, found in the WorkPoint 365 administration.
With logging entering the WorkPoint 365 portfolio, system administrators will gain insight into many technical core WorkPoint processes. To help cope with some use cases we will provide a common knowledge base to help WorkPoint 365 admins get started.
An error can be surfaced from many different layers of the system, be it SharePoint, WorkPoint, etc. It is logged as an exception in the WorkPoint 365 event log, with a red color.
Determines the start and completion of a job. These are marked with a green color, when viewing the event log.
Traces are informational messages from jobs, showing detailed internal processes that are especially helpful when determining the cause of an eventual exception.
A job is an asynchronous task performing WorkPoint 365 actions. Jobs can be either timed or action initiated. The timed jobs will run given a user provided timeframe, for instance every hour or week. An action initiated job could be the result of a user performing an action, like for instance creating a new project or company, or any other business module entity, and thus triggering a master site synchronization job of the new entity.
As of time of writing this document, the following job types are registered. Mind you, that more are on the way and this list might not contain the latest information.
Registered jobs as of December 4th, 2017:
- Buffer sites creation job
- Dynamic Site Creation Job
- Site creation job
- Delete blob files job
- Delete history job
- Delete marked sites job
Site Collection Jobs
- Site collection maintenance job
- Site collection provisioning job
- Site collection synchronization job
- Solution Export/Import job
- Solution provisioning job
- Solution update job
- Master site synchronization job
- Page properties synchronization job
- Update inheritance fields job
- Update inheritance item adding job
- Update number sequence fields job
- Aggregate entities job
- Apply theme job
- Import to list job
- Inherit all entities on business modules job
- Remove event receivers job
- Security replication job
- Set missing numerator numbers job
WorkPoint logging scope id
All WorkPoint job iterations run with a unique id, so that multiple events can be traced to a single operation. This means that a job, for instance a Site collection maintenance job, will have a chain of events associated, giving administrators a detailed overview of actions leading up to another action.
Using the log
The log items are saved up to 3 months. Older than these will be removed by automatic maintenance.
Log items can take some time to collect all information required to create show the events. This task is asynchronous and therefore logs will not be available right away. Depending on the level of detail, some log entries may take more than 10 minutes to be available.
For an overall solution overview, simply navigate to the WorkPoint 365 admin interface. From there, find the ‘WorkPoint Event Logging’ menu item in the left menu and click it. You will now see the event page, filtered to only show exceptions (see screenshot below) for the last thirty minutes Subject to change..
Inspecting a log item
An event will be shown with its most basic log information. Clicking on a log item will open it up and show a more detailed view of the event. As shown in the screenshot below.
Seeing exceptions for the last 30 minutes gives admins an immediate overview of WorkPoint 365 health right now, but using filtering will enable him to view a more detailed report of the solution.
By setting one of the provided time intervals, or manually inputting a custom time frame, admins can check how the system performed various tasks in specific window of time. Please note that we store log items up until a 3-month period. After this, maintenance will automatically clean log entries.
Specifying individual event types (see Event types), using the checkboxes in the upper left corner, will allow admins to focus only on a selected event type. By default, this is only set to exceptions1 when viewing the general event logging page. When showing all Related events, all event types are shown automatically.
Viewing only log items related to a specific type of job is achieved using the ‘Job filter’ control. Admins can filter on all Registered jobs as of December 4th, 2017.
As mentioned in the description of WorkPoint logging scope id, events logged from an iteration of a job will be marked with a common logging scope id. When viewing the log, hovering over a log item will display a link showing ‘Show all related events’, which will filter the log to show all events related to this selected log item, in the period where the job has run. You can see an example of this in the screenshot below.
Viewing the status of a job
Various actions in WorkPoint 365 result in a job, and inspecting the status of a job is most commonly done through following a link, like the ’View all log entries’ link in the picture below, showing a portion of the Scheduled Jobs page:
- Following this link will take you to the logging page, prefiltered on a specific job, showing all event types in the timeframe of the job.