Merge pull request #725 from watson-developer-cloud/transaction-id

Add documentation for getting transaction id

Author: ehdsouza

.env.enc

@@ -31,6 +31,7 @@ Python client library to quickly get started with the various [Watson APIs][wdc]
   * [Setting the service url](#setting-the-service-url)
   * [Sending request headers](#sending-request-headers)
   * [Parsing HTTP response information](#parsing-http-response-information)
+  * [Getting the transaction ID](#getting-the-transaction-id)
   * [Using Websockets](#using-websockets)
   * [Cloud Pak for Data(CP4D)](#cloud-pak-for-data)
   * [Logging](#logging)
@@ -362,6 +363,30 @@ This would give an output of `DetailedResponse` having the structure:
 ```
 You can use the `get_result()`, `get_headers()` and get_status_code() to return the result, headers and status code respectively.
 
+## Getting the transaction ID
+Every SDK call returns a response with a transaction ID in the x-global-transaction-id header. This transaction ID is useful for troubleshooting and accessing relevant logs from your service instance.
+### Suceess
+```python
+from ibm_watson import MyService
+
+service = MyService(authenticator=my_authenticator)
+response_headers = service.my_service_call().get_headers()
+print(response_headers.get('x-global-transaction-id'))
+```
+
+### Failure
+```python
+from ibm_watson import MyService, ApiException
+
+try:
+    service = MyService(authenticator=my_authenticators)
+    service.my_service_call()
+except ApiException as e:
+    print(e.global_transaction_id)
+    # OR
+    print(e.http_response.headers.get('x-global-transaction-id'))
+```
+
 ## Using Websockets
 The Text to Speech service supports synthesizing text to spoken audio using web sockets with the `synthesize_using_websocket`. The Speech to Text service supports recognizing speech to text using web sockets with the `recognize_using_websocket`. These methods need a custom callback class to listen to events. Below is an example of `synthesize_using_websocket`. Note: The service accepts one request per connection.
 

README.md

@@ -3,12 +3,13 @@
   ../resources/personality-v3-expect2.txt
 """
 import json
-from os.path import join, dirname
+import os
+from os.path import join
 from ibm_watson import PersonalityInsightsV3
 import csv
 from ibm_cloud_sdk_core.authenticators import IAMAuthenticator
 
-# Authentication via IAM
+# # Authentication via IAM
 # authenticator = IAMAuthenticator('your_api_key')
 # service = PersonalityInsightsV3(
 #     version='2017-10-13',
@@ -17,7 +18,7 @@
 
 # Authentication via external config like VCAP_SERVICES
 service = PersonalityInsightsV3(version='2017-10-13')
-service.set_service_url('https://gateway.watsonplatform.net/personality-insights/api')
+service.set_service_url('https://api.us-east.personality-insights.watson.cloud.ibm.com/instances/4c18b521-3abd-4c7c-bec7-6a3fd03644f1')
 
 ############################
 # Profile with JSON output #