Deployment Monitoring

Schema App's Deployment Monitoring feature verifies that the correct markup is deploying to the intended pages. It also assesses whether web crawlers can read the deployed schema markup. If any disruptions or discrepancies are found, a notification will be emailed to the account's designated Customer Success Manager so they can resolve issues before they impact site performance.

Table of Contents

• What does Deployment Monitoring do?
• How does Deployment Monitoring work?
• What Information do Email Notifications contain?
• How does Deployment Monitoring sample Highlighter URLs?
• What Limitations could Impact Deployment Monitoring?
• Who has Access to Deployment Monitoring?

What does Deployment Monitoring do?

Deployment Monitoring performs the following functions:

• Verify if schema markup is present on a webpage
• Assesses whether web crawlers can read the schema markup
• Notifies Customer Success Managers when an issue has been identified

How does Deployment Monitoring work?

Schema App will run a daily Deployment Monitoring job on every website we deploy to. Each job will perform the following steps:

1. Identify all sources of Schema App markup deploying to a site (Editor, Highlighter, WordPress, Merchant Center, Shopify, etc.)
2. Procure 100 sample URLs to test across all sources
3. Contact our headless chrome service to test each URL for structured data
4. Store results (whether successful or unsuccessful) in our database
5. Send a report based on the results of the job to the associated Customer Success Manager

If you have multiple sources for one URL, that page will be tested for each source to verify whether appropriate markup is present.

What Information do Email Notifications contain?

If there are any issues with deployment, a notification email will be sent to the Customer Success Manager of the impacted account. Each Deployment Monitoring notification email will include the following:

• The deployment type and source
• Highlighter Template (if applicable)
• # of affected pages
• Possible cause
• Tested URLs
• Date and time of failed deployment

How does Deployment Monitoring sample Highlighter URLs?

Deployment Monitoring will test the URLs provided in Step 3 of a Highlighter Template daily. Then it will sample random URLs that a template has deployed to. The sample of URLs the template has actively deployed to is only up to 30 days OR the last date the template was modified. So, if you update a template's configuration, Deployment Monitoring will only sample URLs from that day onward.

What Limitations could Impact Deployment Monitoring?

The following scenarios could impact the efficacy of Schema App's Deployment Monitoring feature:

• Schema App's user agent isn't whitelisted: Mozilla/5.0 (compatible; SchemaBot/1.2; +https://www.schemaapp.com/bot/)
• Page load exceeds timeout of 90 seconds. If this occurs, we recommend increasing the script priority and/or improving page performance.
• Website is down. If a site is down during this test Deployment Monitoring will interpret this as markup not deploying.
• Determining Source. Not all deployments currently output the source (Drupal, WordPress and schemaFunctions) therefore we can't always identify which block of JSON-LD refers to a particular source with 100% accuracy.
• Pages outside of the sample could still have issues that deployment monitoring is not detecting.
• Templates that deploy to URLs that frequently expire within 10 days (like Job Postings) will regularly throw errors for being unable to find those pages and markup.  The workaround is to add to the exceptions list, however, that's also not great as we'll "never" be able to monitor such things.
• Websites that have multiple templates deploying to the same URL, and are using JavaScript + Caching to deploy, will receive false error messages. Markup from all templates may be present on the page, but the data source will be inconsistent since the cache only stores the source information from the most recent markup sent from highlight.js.

Who has Access to Deployment Monitoring?

This feature is currently in beta and will be available to all accounts by the end of Q2, 2023. Notification emails will exclusively be sent to Customer Success Managers.