Skip to content

Commit

Permalink
Add telemetry section to the Firebase plugin docs. (#555)
Browse files Browse the repository at this point in the history
  • Loading branch information
kmandrika authored Jul 8, 2024
1 parent 3779de1 commit 431b7fb
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions docs/plugins/firebase.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ npm i --save @genkit-ai/firebase

## Configuration

### Project ID

To use this plugin, specify it when you call `configureGenkit()`:

<!--See note above on prettier-ignore -->
Expand Down Expand Up @@ -69,6 +71,28 @@ Application Default Credentials. To specify your credentials:
1. Set the environment variable `GOOGLE_APPLICATION_CREDENTIALS` to the file
path of the JSON file that contains your service account key.

### Telemetry

The plugin has a direct dependency on the [Google Cloud plugin](google-cloud.md) and thus has provisions to enable telemetry export to Google's Cloud operations suite. To enable telemetry export, set the `enableTracingAndMetrics` to `true` and add a telemetry section to the Genkit configuration:

<!--See note above on prettier-ignore -->
<!-- prettier-ignore -->
```js
import {configureGenkit} from "@genkit-ai/core";
import {firebase} from "@genkit-ai/firebase";

configureGenkit({
plugins: [firebase()],
enableTracingAndMetrics: true,
telemetry: {
instrumentation: 'firebase',
logger: 'firebase',
},
});
```

Refer the the [Google Cloud plugin](google-cloud.md) documentation for all configuration options and the necessary APIs that need to be enabled on the project.

## Usage

This plugin provides several integrations with Firebase services, which you can
Expand Down

0 comments on commit 431b7fb

Please sign in to comment.