Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add telemetry section to the Firebase plugin docs. #555

Merged
merged 1 commit into from
Jul 8, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading