Submitting custom iframe success/failure events for Cloud Fortified

Hi all,
If you’re participating in the Cloud Fortified program, you might discover that the iframe success rate metric we monitor by default doesn’t work well for some apps, because under some conditions it can report failures that are due to client behaviours that aren’t actionable by app developers (e.g. browser throttling when there are many concurrent requests).

We’re working on improvements to minimise these cases, but in the meantime if this is affecting you (i.e. you are seeing poor iframe success rate or latency metrics for your app on that don’t map to any real issues in your app), we recommend reporting your own view of iframe load successes/failures back to us using the metrics API – we’ll then track that metric in preference over the generic metric.

@CharlieEaly reached out to us with some good questions on this topic which we thought would be useful for everyone:

  1. Atlassian measures success via time (3 seconds). Do we also have to report any time in the durationInMillis if we give a SUCCESS response or is it sufficient to say simply it was successful?

For custom iframe success rate we do track the response time in ms as the “latency” metric, so we’d appreciate it if you could include it for success metrics. (As an aside, for synthetic test results, the API also accepts a value for latency, but for now we ignore it).

  1. Is a user error defined as FAILURE or SUCCESS (for example, if the user deletes the attachment from the page and then tries to open it via macro)?

When the app is behaving as expected, you should report it as a success. If your app is handling user errors (e.g. showing an error message), this should still be considered a success. The intent of this metric is to identify cases where the app is not behaving as expected (whether the issue is in the app or the host product).

  1. If it is FAILURE, should we log it ourselves too, so that we can see what the problem was, when it happened, etc?

Yes, we strongly recommend including logging for failure cases if you don’t have this already to assist with mitigation and analysis.

Don’t hesitate to reach out here if you have any questions on Cloud Fortified apps.