Skip to content

Commit 6c5af6f

Browse files
Update readme for Firebase customers use of Crash Functions
1 parent b9fcdc0 commit 6c5af6f

File tree

3 files changed

+24
-27
lines changed

3 files changed

+24
-27
lines changed

crashlytics-integration/email-notifier/README.md

+8-9
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,24 @@
11
# Crashlytics Email Notifier
22

3-
Identify important conversion workflows in your app, so that when a new issue is reported in that workflow via Crashlytics, an email will be sent to you or the specified recipient. This will allow you to react quicker to crashes that impact important conversion workflows of your app.
3+
Identify important conversion workflows in your app, so that when a new issue is reported in that workflow via Crashlytics, an email is sent to you. This will allow you to react quicker to crashes that impact important conversion workflows of your app.
4+
5+
Crashlytics is a crash reporter for Firebase.
6+
7+
Note: This assumes that you have Crashlytics in Firebase. [Learn more about Crashlytics](https://firebase.google.com/docs/crashlytics/)
48

5-
Crashlytics will become the future crash reporter for Firebase. Learn more about Crashlytics [here](https://fabric.io/kits/android/crashlytics/summary?ref=fb).
69

710
## Setting up the sample
811

912
Create and setup the Firebase project:
1013
1. Create a Firebase project using the [Firebase Developer Console](https://console.firebase.google.com).
1114
1. Enable Billing on your Firebase the project by switching to the **Blaze** plan, this is currently needed to be able to perform HTTP requests to external services from a Cloud Function.
12-
13-
Create and setup Crashlytics in your app:
14-
1. Create an account on [Fabric](https://fabric.io/kits?show_signup=true).
15-
1. Setup Crashlytics for your app as described in the [Crashlytics setup instructions](https://fabric.io/kits/android/crashlytics)
15+
1. Include [Crashlytics in your project](https://firebase.google.com/docs/crashlytics/get-started).
1616

1717
Configuring the sample
1818
1. Clone or download this repo and open the `crashlytics-integration/email-notifier` directory.
1919
1. You must have the Firebase CLI installed. If you don't have it, install it with `npm install -g firebase-tools` and then configure it with `firebase login`.
2020
1. Configure the CLI locally by using `firebase use --add` and select your project in the list.
2121
1. Install `npm` dependencies in the functions directory locally, by running: `cd functions; npm install;`
22-
1. Configure the Firebase CLI to set your Fabric Project ID `firebase functions:config:set fabric.project_id="<YOUR_FABRIC_PROJECT_ID>"`
23-
1. How do I find my Fabric Project ID? Go into App Settings in your Fabric Dashboard and select the app you would like to use. The URL will contain your Fabric Project Id: `https://fabric.io/settings/apps/<YOUR_FABRIC_PROJECT_ID>`
2422

2523
Configuring the Email Service
2624
1. This sample uses [SendGrid](https://sendgrid.com) to send the emails, but you can use any other email provider.
@@ -32,10 +30,11 @@ Crashlytics will become the future crash reporter for Firebase. Learn more about
3230
1. Specify the email that you would like to use to *receive* the alerts by using: `firebase functions:config:set email.destination_email="[email protected]"`
3331
1. Specify the email that you would like to use to *send* the alerts by using: `firebase functions:config:set email.from_email="[email protected]"
3432

33+
3534
## Deploy and test
3635

3736
1. Deploy your project using `firebase deploy`
38-
1. Simulate a test crash. [Android Instructions](https://docs.fabric.io/android/crashlytics/test-crash.html) | [iOS Instructions](https://docs.fabric.io/apple/crashlytics/test-crash.html)
37+
1. Simulate a test crash. [Instructions](https://firebase.google.com/docs/crashlytics/force-a-crash)
3938

4039

4140
## Contributing

crashlytics-integration/jira-issue/README.md

+8-9
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,33 @@
22

33
Identify important conversion workflows in your app, so that when a new issue is reported in that workflow via Crashlytics, an issue will be created in your Jira project. This will allow you to react quicker to crashes that impact important conversion workflows of your app.
44

5-
Crashlytics will become the future crash reporter for Firebase. Learn more about Crashlytics [here](https://fabric.io/kits/android/crashlytics/summary?ref=fb).
5+
Crashlytics is a crash reporter for Firebase.
6+
7+
Note: This assumes that you have Crashlytics in Firebase. [Learn more about Crashlytics](https://firebase.google.com/docs/crashlytics/)
8+
69

710
## Setting up the sample
811

912
Create and setup the Firebase project:
1013
1. Create a Firebase project using the [Firebase Developer Console](https://console.firebase.google.com).
1114
1. Enable Billing on your Firebase the project by switching to the **Blaze** plan, this is currently needed to be able to perform HTTP requests to external services from a Cloud Function.
12-
13-
Create and setup Crashlytics in your app:
14-
1. Create an account on [Fabric](https://fabric.io/kits?show_signup=true).
15-
1. Setup Crashlytics for your app as described in the [Crashlytics setup instructions](https://fabric.io/kits/android/crashlytics)
15+
1.Include [Crashlytics in your project](https://firebase.google.com/docs/crashlytics/get-started).
1616

1717
Configuring the sample
1818
1. Clone or download this repo and open the `crashlytics-integration/jira-issue` directory.
19-
1. You must have the Firebase CLI installed. If you don't have it install it with `npm install -g firebase-tools` and then configure it with `firebase login`.
19+
1. You must have the Firebase CLI installed. If you don't have it, install it with `npm install -g firebase-tools` and then configure it with `firebase login`.
2020
1. Configure the CLI locally by using `firebase use --add` and select your project in the list.
2121
1. Install `npm` dependencies in the functions directory locally, by running: `cd functions; npm install;`
22-
1. Configure the Firebase CLI to set your Fabric Project ID `firebase functions:config:set fabric.project_id="<YOUR_FABRIC_PROJECT_ID>"`
23-
1. How do I find my Fabric Project ID? Go into App Settings in your Fabric Dashboard and select the app you would like to use. The URL will contain your Fabric Project Id: `https://fabric.io/settings/apps/<YOUR_FABRIC_PROJECT_ID>`
2422

2523
Integrating with Jira
2624
1. Configure the required environment variables for Jira: `firebase functions:config:set jira.project_url="https://yourdomain.atlassian.net/projects/XX" jira.user="username" jira.pass="password"`
2725
1. You may also specify two optional environment variables as well `firebase functions:config:set jira.issue_type="bug" jira.component_id="10000"`
26+
2827

2928
## Deploy and test
3029

3130
1. Deploy your project using `firebase deploy`
32-
1. Simulate a test crash. [Android Instructions](https://docs.fabric.io/android/crashlytics/test-crash.html) | [iOS Instructions](https://docs.fabric.io/apple/crashlytics/test-crash.html)
31+
1. Simulate a test crash. [Instructions](https://firebase.google.com/docs/crashlytics/force-a-crash)
3332

3433

3534
## Contributing

crashlytics-integration/slack-notifier/README.md

+8-9
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,33 @@
22

33
Identify important conversion workflows in your app, so that when a new issue is reported in that workflow via Crashlytics, a slack notification will be sent to a specific channel on Slack. This will allow you to react quicker to crashes that impact important conversion workflows of your app.
44

5-
Crashlytics will become the future crash reporter for Firebase. Learn more about Crashlytics [here](https://fabric.io/kits/android/crashlytics/summary?ref=fb).
5+
Crashlytics is a crash reporter for Firebase.
6+
7+
Note: This assumes that you have Crashlytics in Firebase. [Learn more about Crashlytics](https://firebase.google.com/docs/crashlytics/)
8+
69

710
## Setting up the sample
811

912
Create and setup the Firebase project:
1013
1. Create a Firebase project using the [Firebase Developer Console](https://console.firebase.google.com).
1114
1. Enable Billing on your Firebase the project by switching to the **Blaze** plan, this is currently needed to be able to perform HTTP requests to external services from a Cloud Function.
12-
13-
Create and setup Crashlytics in your app:
14-
1. Create an account on [Fabric](https://fabric.io/kits?show_signup=true).
15-
1. Setup Crashlytics for your app as described in the [Crashlytics setup instructions](https://fabric.io/kits/android/crashlytics)
15+
1. Include [Crashlytics in your project](https://firebase.google.com/docs/crashlytics/get-started).
1616

1717
Configuring the sample
1818
1. Clone or download this repo and open the `crashlytics-integration/slack-notifier` directory.
19-
1. You must have the Firebase CLI installed. If you don't have it install it with `npm install -g firebase-tools` and then configure it with `firebase login`.
19+
1. You must have the Firebase CLI installed. If you don't have it, install it with `npm install -g firebase-tools` and then configure it with `firebase login`.
2020
1. Configure the CLI locally by using `firebase use --add` and select your project in the list.
2121
1. Install `npm` dependencies in the functions directory locally, by running: `cd functions; npm install;`
22-
1. Configure the Firebase CLI to set your Fabric Project ID `firebase functions:config:set fabric.project_id="<YOUR_FABRIC_PROJECT_ID>"`
23-
1. How do I find my Fabric Project ID? Go into App Settings in your Fabric Dashboard and select the app you would like to use. The URL will contain your Fabric Project Id: `https://fabric.io/settings/apps/<YOUR_FABRIC_PROJECT_ID>`
2422

2523
Setting up an Incoming Slack Webhook
2624
1. Set up an [incoming webhook integration](https://my.slack.com/services/new/incoming-webhook/) in your Slack team. Take note of the **Webhook URL**.
2725
1. Config and set the environment variable for the webhook URL: `firebase functions:config:set slack.webhook_url="https://hooks.slack.com/services/...`
26+
2827

2928
## Deploy and test
3029

3130
1. Deploy your project using `firebase deploy`
32-
1. Simulate a test crash. [Android Instructions](https://docs.fabric.io/android/crashlytics/test-crash.html) | [iOS Instructions](https://docs.fabric.io/apple/crashlytics/test-crash.html)
31+
1. Simulate a test crash. [Instructions](https://firebase.google.com/docs/crashlytics/force-a-crash)
3332

3433

3534
## Contributing

0 commit comments

Comments
 (0)