How do I integrate lightning JS3 with Firebolt APIs. Please help me?

Get Help
1

I’m currently working on integrating the Firebolt API with Lightning JS3. I’ve already built a basic working project in Lightning JS3, but now I’m trying to integrate the Firebolt API. I’m a bit stuck and would appreciate some guidance on how to proceed.

Specifically, the Firebolt documentation mentions that I need to call the Metrics API every time an error occurs in my code. In my project, I have multiple instances where I throw errors using throw() and also catch errors using try-catch blocks.

For example, I have code like this:

throw("Unknown code: Video format is not supported.");

In such cases, do I need to call the Firebolt Metrics API? The documentation suggests using the Metrics API for error tracking. Here’s an example of how I think it should work:

import { Metrics } from '@firebolt-js/sdk';

// My code
try {
  // Some code that might throw an error
} catch (error) {
  Metrics.error("media", "MEDIA-STALLED", "playback stalled", true, null)
    .then(success => {
      console.log(success);
    });
}

Could you please clarify if this is the correct approach? Any help or advice would be greatly appreciated!

2

Hi @karandeep . I believe what you’re doing is mostly right.

You don’t need to log absolutely every error that happens in your application. Just focus on those errors whose types match one of the categories Comcast is expecting, which are usually things the user will see, playback issues, analytics perhaps, etc.

You can be even more thorough and if you have like a place where all errors are routed, you could perhaps have a single place were to call the Firebolt api. However, if they are all scattered, you’d most likely need to call the API on each catch block you have on your code.

It all depends how you have structured your application. Hope this helps!