Add documentation for service hook logs

The changes describe how to troubleshoot project services using service hook logs

Add documentation for service hook logs
The changes describe how to troubleshoot project services using service hook logs
bf049064 · Andy Soiron · Russell Dickenson · 7b2a8727 · bf049064 · bf049064
Commit bf049064 authored Jan 20, 2020 by Andy Soiron Committed by Russell Dickenson Jan 20, 2020
4 changed files
--- a/doc/integration/jenkins.md
+++ b/doc/integration/jenkins.md
@@ -138,7 +138,7 @@ configured or there was an error reporting the status via the API.
 ### Merge Request event does not trigger a Jenkins Pipeline
-Check the `/var/log/gitlab/gitlab-rails/production.log` file for messages like:
+Check [service hook logs](../user/project/integrations/project_services.md#troubleshooting-project-services) for request failures or check the `/var/log/gitlab/gitlab-rails/production.log` file for messages like:
 ```plaintext
 WebHook Error => Net::ReadTimeout

--- a/doc/user/project/integrations/bamboo.md
+++ b/doc/user/project/integrations/bamboo.md
@@ -55,7 +55,7 @@ service in GitLab.
 ## Troubleshooting
 If builds are not triggered, ensure you entered the right GitLab IP address in
-Bamboo under 'Trigger IP addresses'.
+Bamboo under 'Trigger IP addresses'. Also check [service hook logs](project_services.md#troubleshooting-project-services) for request failures.
 NOTE: **Note:**
 Starting with GitLab 8.14.0, builds are triggered on push events.
--- a/doc/user/project/integrations/bugzilla.md
+++ b/doc/user/project/integrations/bugzilla.md
@@ -26,3 +26,7 @@ We suggest using the longer format if you have both internal and external issue
 Please note that `<PROJECT>` part is ignored and links always point to the
 address specified in `issues_url`.
+## Troubleshooting
+To see recent service hook deliveries, check [service hook logs](project_services.md#troubleshooting-project-services).
--- a/doc/user/project/integrations/project_services.md
+++ b/doc/user/project/integrations/project_services.md
@@ -20,42 +20,42 @@ Below, you will find a list of the currently supported ones accompanied with com
 Click on the service links to see further configuration instructions and details.
-| Service | Description |
+| Service | Description | Service Hooks |
-| ------- | ----------- |
+| ------- | ----------- | ------------- |
-| Asana     | Asana - Teamwork without email |
+| Asana     | Asana - Teamwork without email | No |
-| Assembla | Project Management Software (Source Commits Endpoint) |
+| Assembla | Project Management Software (Source Commits Endpoint) | No |
-| [Atlassian Bamboo CI](bamboo.md) | A continuous integration and build server |
+| [Atlassian Bamboo CI](bamboo.md) | A continuous integration and build server | Yes |
-| Buildkite | Continuous integration and deployments |
+| Buildkite | Continuous integration and deployments | Yes |
-| [Bugzilla](bugzilla.md) | Bugzilla issue tracker |
+| [Bugzilla](bugzilla.md) | Bugzilla issue tracker | No |
-| Campfire | Simple web-based real-time group chat |
+| Campfire | Simple web-based real-time group chat | No |
-| Custom Issue Tracker | Custom issue tracker |
+| Custom Issue Tracker | Custom issue tracker | No |
-| [Discord Notifications](discord_notifications.md) | Receive event notifications in Discord |
+| [Discord Notifications](discord_notifications.md) | Receive event notifications in Discord | No |
-| Drone CI | Continuous Integration platform built on Docker, written in Go |
+| Drone CI | Continuous Integration platform built on Docker, written in Go | Yes |
-| [Emails on push](emails_on_push.md) | Email the commits and diff of each push to a list of recipients |
+| [Emails on push](emails_on_push.md) | Email the commits and diff of each push to a list of recipients | No |
-| External Wiki | Replaces the link to the internal wiki with a link to an external wiki |
+| External Wiki | Replaces the link to the internal wiki with a link to an external wiki | No |
-| Flowdock | Flowdock is a collaboration web app for technical teams |
+| Flowdock | Flowdock is a collaboration web app for technical teams | No |
-| [Generic alerts](generic_alerts.md) **(ULTIMATE)** | Receive alerts on GitLab from any source |
+| [Generic alerts](generic_alerts.md) **(ULTIMATE)** | Receive alerts on GitLab from any source | No |
-| [GitHub](github.md) **(PREMIUM)** | Sends pipeline notifications to GitHub |
+| [GitHub](github.md) **(PREMIUM)** | Sends pipeline notifications to GitHub | No |
-| [Hangouts Chat](hangouts_chat.md) | Receive events notifications in Google Hangouts Chat |
+| [Hangouts Chat](hangouts_chat.md) | Receive events notifications in Google Hangouts Chat | No |
-| [HipChat](hipchat.md) | Private group chat and IM |
+| [HipChat](hipchat.md) | Private group chat and IM | No |
-| [Irker (IRC gateway)](irker.md) | Send IRC messages, on update, to a list of recipients through an Irker gateway |
+| [Irker (IRC gateway)](irker.md) | Send IRC messages, on update, to a list of recipients through an Irker gateway | No |
-| [Jira](jira.md) | Jira issue tracker |
+| [Jira](jira.md) | Jira issue tracker | No |
-| [Jenkins](../../../integration/jenkins.md) **(STARTER)** | An extendable open source continuous integration server |
+| [Jenkins](../../../integration/jenkins.md) **(STARTER)** | An extendable open source continuous integration server | Yes |
-| JetBrains TeamCity CI | A continuous integration and build server |
+| JetBrains TeamCity CI | A continuous integration and build server | Yes |
-| [Mattermost slash commands](mattermost_slash_commands.md) | Mattermost chat and ChatOps slash commands |
+| [Mattermost slash commands](mattermost_slash_commands.md) | Mattermost chat and ChatOps slash commands | No |
-| [Mattermost Notifications](mattermost.md) | Receive event notifications in Mattermost |
+| [Mattermost Notifications](mattermost.md) | Receive event notifications in Mattermost | No |
-| [Microsoft teams](microsoft_teams.md) |  Receive notifications for actions that happen on GitLab into a room on Microsoft Teams using Office 365 Connectors |
+| [Microsoft teams](microsoft_teams.md) |  Receive notifications for actions that happen on GitLab into a room on Microsoft Teams using Office 365 Connectors | No |
-| Packagist | Update your project on Packagist, the main Composer repository |
+| Packagist | Update your project on Packagist, the main Composer repository | Yes |
-| Pipelines emails | Email the pipeline status to a list of recipients |
+| Pipelines emails | Email the pipeline status to a list of recipients | No |
-| [Slack Notifications](slack.md) | Send GitLab events (e.g. issue created) to Slack as notifications |
+| [Slack Notifications](slack.md) | Send GitLab events (e.g. issue created) to Slack as notifications | No |
-| [Slack slash commands](slack_slash_commands.md) **(CORE ONLY)** | Use slash commands in Slack to control GitLab |
+| [Slack slash commands](slack_slash_commands.md) **(CORE ONLY)** | Use slash commands in Slack to control GitLab | No |
-| [GitLab Slack application](gitlab_slack_application.md) **(FREE ONLY)** | Use Slack's official application |
+| [GitLab Slack application](gitlab_slack_application.md) **(FREE ONLY)** | Use Slack's official application | No |
-| PivotalTracker | Project Management Software (Source Commits Endpoint) |
+| PivotalTracker | Project Management Software (Source Commits Endpoint) | No |
-| [Prometheus](prometheus.md) | Monitor the performance of your deployed apps |
+| [Prometheus](prometheus.md) | Monitor the performance of your deployed apps | No |
-| Pushover | Pushover makes it easy to get real-time notifications on your Android device, iPhone, iPad, and Desktop |
+| Pushover | Pushover makes it easy to get real-time notifications on your Android device, iPhone, iPad, and Desktop | No |
-| [Redmine](redmine.md) | Redmine issue tracker |
+| [Redmine](redmine.md) | Redmine issue tracker | No |
-| [Unify Circuit](unify_circuit.md) | Receive events notifications in Unify Circuit |
+| [Unify Circuit](unify_circuit.md) | Receive events notifications in Unify Circuit | No |
-| [YouTrack](youtrack.md) | YouTrack issue tracker |
+| [YouTrack](youtrack.md) | YouTrack issue tracker | No |
 ## Push hooks limit
@@ -74,6 +74,25 @@ your liking which will then be pre-filled on each project's Service.
 Read more about [Services templates in this document](services_templates.md).
+## Troubleshooting project services
+Some project services use service hooks for integration with external applications. To confirm which ones use service hooks, see the [services table](#services). GitLab stores details of service hook requests made within the last 2 days. To view details of the requests, go to the service's configuration page.
+The **Recent Deliveries** section lists the details of each request made within the last 2 days:
+- HTTP status code (green for 200-299 codes, red for the others, `internal error` for failed deliveries)
+- Triggered event
+- URL to which the request was sent
+- Elapsed time of the request
+- Relative time in which the request was made
+To view more information about the request's execution, click the respective **View details** link.
+On the details page, you can see the data sent by GitLab (request headers and body) and the data received by GitLab (response headers and body).
+From this page, you can repeat delivery with the same data by clicking **Resend Request**.
+![Recent deliveries](img/webhook_logs.png)
 ## Contributing to project services
 Because GitLab is open source we can ship with the code and tests for all