Skip to content

Commit 99df670

Browse files
author
Stephen Cefali
authored
docs(integrations): adds bitbucket server docs (#1519)
1 parent a870eed commit 99df670

File tree

2 files changed

+101
-8
lines changed

2 files changed

+101
-8
lines changed

src/collections/_documentation/workflow/integrations/global-integrations.md

Lines changed: 100 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Prevent empty queries on users
9797
Fixes MYAPP-317
9898
```
9999

100-
When Sentry sees this, we’ll automatically annotate the matching issue with a reference to the commit, and, later, when that commit is part of a release, we’ll mark the issue as resolved.
100+
When Sentry sees this, we’ll automatically annotate the matching issue with reference to the commit, and later, when that commit is part of a release, we’ll mark the issue as resolved.
101101

102102
#### Troubleshooting
103103

@@ -112,7 +112,7 @@ If you reach the account selection page during the Azure Devops installation pro
112112

113113
### Bitbucket
114114

115-
You can now use the data from your Bitbucket commits to help you find and fix bugs faster.
115+
You can use the data from your Bitbucket commits to help find and fix bugs faster.
116116

117117
#### Configure Bitbucket
118118

@@ -175,7 +175,99 @@ Prevent empty queries on users
175175
Fixes MYAPP-317
176176
```
177177

178-
When Sentry sees this, we’ll automatically annotate the matching issue with a reference to the commit, and, later, when that commit is part of a release, we’ll mark the issue as resolved.
178+
When Sentry sees this, we’ll automatically annotate the matching issue with reference to the commit, and later, when that commit is part of a release, we’ll mark the issue as resolved.
179+
180+
181+
### Bitbucket Server
182+
183+
You can use the data from your Bitbucket Server commits to help find and fix bugs faster.
184+
185+
#### Installing Bitbucket Server with Sentry
186+
187+
{% capture __alert_content -%}
188+
Sentry owner or manager permissions, and Bitbucket administrator permissions are required to install this integration.
189+
{%- endcapture -%}
190+
{%- include components/alert.html
191+
title="Note"
192+
content=__alert_content
193+
level="warning"
194+
%}
195+
196+
##### I. Generate an RSA public/private key pair
197+
To generate an RSA public/private key pair, run the following commands in your terminal window one by one.
198+
```
199+
openssl genrsa -out bitbucket_privatekey.pem 1024
200+
openssl req -newkey rsa:1024 -x509 -key bitbucket_privatekey.pem -out bitbucket_publickey.cer -days 365
201+
openssl pkcs8 -topk8 -nocrypt -in bitbucket_privatekey.pem -out bitbucket_privatekey.pcks8
202+
openssl x509 -pubkey -noout -in bitbucket_publickey.cer > bitbucket_publickey.pem
203+
```
204+
205+
##### II. Create a new application link in Bitbucket
206+
1. In Bitbucket, click the **gear icon** > **Applications** > **Application Links**.
207+
1. Enter the following as the application URL:
208+
`https://sentry.io/extensions/bitbucket_server/setup/`
209+
1. Click **Create New Link**. If you see a warning that “No response was received from the URL you entered,” ignore and click **Continue**.
210+
1. In the resulting dialog, fill out the form as follows:
211+
212+
| Application Name | Sentry |
213+
| Application Type | Generic Application |
214+
| Service Provider Name | Sentry |
215+
| Consumer Key | (your choice, but keep this handy for the next step) |
216+
| Shared Secret | sentry |
217+
| Request Token URL | https://sentry.io |
218+
| Access Token URL | https://sentry.io |
219+
| Authorize URL | https://sentry.io |
220+
| Create Incoming Link | No |
221+
1. Click **Continue**. This will return you to the **Configure Application Links** page, where you'll see an application called **Sentry**.
222+
1. Click the pencil icon next to the **Sentry** application.
223+
1. On the lefthand side of the resulting modal, click **Incoming Authentication**. Fill out the form as follows, and press **Save**:
224+
225+
| Consumer Key | (the consumer key from Step II.4) |
226+
| Consumer Name | Sentry |
227+
| Public Key | (the public key you created in Section I) |
228+
| Consumer Callback URL | https://sentry.io/extensions/bitbucket_server/setup/ |
229+
| Allow 2-Legged OAuth | no |
230+
231+
##### III. Connect your Bitbucket Server application with Sentry
232+
{% capture __alert_content -%}
233+
Make sure you have whitelisted [Sentry's IP ranges.](https://docs.sentry.io/ip-ranges/)
234+
{%- endcapture -%}
235+
{%- include components/alert.html
236+
title="Note"
237+
content=__alert_content
238+
level="warning"
239+
%}
240+
1. In Sentry, navigate to **Organization Settings** > **Integrations**.
241+
2. Next to Bitbucket Server, click **Install**.
242+
3. In the resulting modal, click **Add Installation**.
243+
4. In the resulting window, enter the base URL for your Bitbucket Server instance, your consumer key, and your private key. Click **Submit**. Then, complete the OAuth process as prompted.
244+
5. In Sentry, you’ll see a new Bitbucket Server instance appear on the Integrations page.
245+
246+
Bitbucket should now be authorized for all projects under your Sentry organization.
247+
248+
#### Commit Tracking
249+
250+
Commit tracking allows you to hone in on problematic commits. Learn more about [commit tracking]({%- link _documentation/workflow/releases.md -%}#link-repository).
251+
252+
#### Suspect Commits and Suggested Assignees
253+
254+
Once you set up commit tracking, you’ll be able to see the most recent changes to files found in the issue’s stack trace with suspect commits.
255+
256+
For issues where the files in the stack trace match files included in commits sent to Sentry, you’ll see the suspect commit, with a link to the commit itself.
257+
258+
You’ll also see that the author of the suspect commit will be listed as a suggested assignee for this issue. To assign the issue to the suggested assignee, click on their icon.
259+
260+
#### Resolving in Commit
261+
262+
Once you are sending commit data, you can start resolving issues by including `fixes <SENTRY-SHORT-ID>` in your commit messages. For example, a commit message might look like:
263+
264+
```
265+
Prevent empty queries on users
266+
267+
Fixes MYAPP-317
268+
```
269+
270+
When Sentry sees this, we’ll automatically annotate the matching issue with reference to the commit, and later, when that commit is part of a release, we’ll mark the issue as resolved.
179271

180272
### ClickUp
181273

@@ -277,7 +369,7 @@ You can take a Sentry Issue, create a Clubhouse Story, and link the two.
277369

278370
### GitHub
279371

280-
You can now use the data from your GitHub commits to help you find and fix bugs faster.
372+
You can use the data from your GitHub commits to help find and fix bugs faster.
281373

282374
#### Configure GitHub
283375

@@ -351,7 +443,7 @@ When Sentry sees this, we’ll automatically annotate the matching issue with a
351443

352444
### GitHub Enterprise
353445

354-
You can now use the data from your GitHub Enterprise commits to help you find and fix bugs faster.
446+
You can use the data from your GitHub Enterprise commits to help find and fix bugs faster.
355447

356448
#### Configure GitHub Enterprise
357449

@@ -699,7 +791,7 @@ openssl x509 -pubkey -noout -in jira_publickey.cer > jira_publickey.pem
699791
1. In Jira, click the **gear icon** > **Applications** > **Application Links**.
700792
1. Enter the following as the application URL:
701793
`https://sentry.io/extensions/jira_server/setup/`
702-
1. Click **Create New Link**. If you see a warning that “No response was received from the URL you entered”, ignore and click **Continue**.
794+
1. Click **Create New Link**. If you see a warning that “No response was received from the URL you entered,” ignore and click **Continue**.
703795
1. In the resulting dialog, fill out the form as follows:
704796
705797
| Application Name | Sentry |
@@ -711,9 +803,9 @@ openssl x509 -pubkey -noout -in jira_publickey.cer > jira_publickey.pem
711803
| Access Token URL | https://sentry.io |
712804
| Authorize URL | https://sentry.io |
713805
| Create Incoming Link | No |
714-
1. Click **Continue**. You should be returned to the **Configure Application Links** page, where you should see an application called **Sentry**.
806+
1. Click **Continue**. This will return you to the **Configure Application Links** page, where you'll see an application called **Sentry**.
715807
1. Click the pencil icon next to the **Sentry** application.
716-
1. On the lefthand side of the resulting modal, click **Incoming Authentication**. Fill our the form as follows, and press **Save**:
808+
1. On the lefthand side of the resulting modal, click **Incoming Authentication**. Fill out the form as follows, and press **Save**:
717809
718810
| Consumer Key | (the consumer key from Step II.4) |
719811
| Consumer Name | Sentry |

src/collections/_documentation/workflow/integrations/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ These integrations are set up once per organization, and are then usable in all
1111

1212
- [_Azure DevOps_]({%- link _documentation/workflow/integrations/global-integrations.md -%}#azure-devops)
1313
- [_Bitbucket_]({%- link _documentation/workflow/integrations/global-integrations.md -%}#bitbucket)
14+
- [_Bitbucket Server_]({%- link _documentation/workflow/integrations/global-integrations.md -%}#bitbucket-server)
1415
- [_GitHub_]({%- link _documentation/workflow/integrations/global-integrations.md -%}#github)
1516
- [_GitHub Enterprise_]({%- link _documentation/workflow/integrations/global-integrations.md -%}#github-enterprise)
1617
- [_GitLab_]({%- link _documentation/workflow/integrations/global-integrations.md -%}#gitlab)

0 commit comments

Comments
 (0)