Skip to content

Commit d477256

Browse files
authored
corrections to the attachment references
1 parent a9ae128 commit d477256

File tree

1 file changed

+16
-16
lines changed
  • docs/articles/features/Custom Destinations

1 file changed

+16
-16
lines changed

docs/articles/features/Custom Destinations/README.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -96,29 +96,29 @@ Login to API Gateway, expand the menu options icon available in the top right in
9696

9797
Provide a Unique Name for the Custom destination. Supported characters are [a-zA-Z0-9-_ ].
9898

99-
![CD_Name](attachments\CD_Name.PNG)
99+
![CD_Name](attachments/CD_Name.PNG)
100100

101101
### Condition based publishing
102102

103103
You can configure conditions based on which API Gateway filters events to publish to a configured destination. That is, only the events that satisfy your conditions are published to the given destination. For example, you can configure a condition to publish the error events of an application, say app1, to a destination; and another condition to publish the error events of another application, app2, to a second destination and so on.
104104

105-
![condition_based_publishing](attachments\condition_based_publishing.png)
105+
![condition_based_publishing](attachments/condition_based_publishing.png)
106106

107107
To configure a condition, you can use variables available in the variable framework, and specify a matching value based on which the condition must be validated. You can specify multiple conditions and configure whether the data to be published must satisfy all or any of the given conditions. The use cases in this section explain the process of configuring conditions.
108108

109109
#### Conditions:
110110

111111
Conditions are completely optional. One can configure multiple conditions and everything will be validated based on the Condition type. In this case, if the application name matches with **'Splunk HEC Application',** only then API Gateway will send the configured events to Splunk.
112112

113-
![CD_Conditions](attachments\CD_Conditions.PNG)
113+
![CD_Conditions](attachments/CD_Conditions.PNG)
114114

115115
After configuring the condition variable and value click Add.
116116

117117
#### Type - External endpoint:
118118

119119
Select the Custom destination type as External endpoint and provide the necessary details like URL, Method, SSL, and Timeout.
120120

121-
![CD_ExternalEndpoint](attachments\CD_ExternalEndpoint.PNG)
121+
![CD_ExternalEndpoint](attachments/CD_ExternalEndpoint.PNG)
122122

123123
#### Request Processing:
124124

@@ -128,21 +128,21 @@ Header Name: Authorization
128128

129129
Header Value: Encode ***"****Splunk <<SplunkToken>>"*** and configure it as Basic <<encoded value>>, then Click Add.
130130

131-
![CD_Header_Configure](attachments\CD_Header_Configure.PNG)
131+
![CD_Header_Configure](attachments/CD_Header_Configure.PNG)
132132

133133
#### Events:
134134

135135
Select the data that you want to publish to the configured destination.
136136

137-
![CD_Events](attachments\CD_Events.PNG)
137+
![CD_Events](attachments/CD_Events.PNG)
138138

139139
After all the successful configuration click Add to add Custom destination.
140140

141141
### Step 3: Create the API and add Custom Destination
142142

143143
Login to API Gateway and create a *Petstore* API from the swagger definition URL http://petstore.swagger.io/v2/swagger.json alternatively you can use the existing API which is already available in API Gateway. Edit the API, go to *Policies → Traffic Monitoring →* Add *Log Invocation → Select Splunk HEC under Destination*.
144144

145-
![CD_API](attachments\CD_API.PNG)
145+
![CD_API](attachments/CD_API.PNG)
146146

147147
After all the configuration click Save and Activate the API.
148148

@@ -152,7 +152,7 @@ Invoke the API using a REST client like Postman to generate Transactional Event
152152

153153
Open Splunk and search for **sourcetype="httpevent",** the splunk search will look like this,
154154

155-
![CD_Splunk_Events](attachments\CD_Splunk_Events.PNG)
155+
![CD_Splunk_Events](attachments/CD_Splunk_Events.PNG)
156156

157157
From the search response you can see the Audit log for Activate and Deactivate, and Transactional events published to Splunk.
158158

@@ -180,7 +180,7 @@ public class APIGatewayEvents implements RequestHandler<Object, String> {
180180

181181
To invoke a Lambda function, we need to create a AWS account configuration in the API Gateway Administration section with the Access key ID, Secret access key and Region. This can be created by navigating to Administration → External accounts → AWS configuration. Configure the AWS account details here and use it as an alias in the Custom Destination. API Gateway supports configuration of multiple AWS accounts.
182182

183-
![AWS_Config](attachments\AWS_Config.PNG)
183+
![AWS_Config](attachments/AWS_Config.PNG)
184184

185185
Click Add to add the AWS account in API Gateway.
186186

@@ -192,7 +192,7 @@ Name, Conditions, Request Processing, and Events sections remains same for AWS L
192192

193193
Select the Custom destination type as AWS and provide the necessary details like Function Name, Invocation Type, AWS Alias, and Client Configuration.
194194

195-
![CD_AWS](attachments\CD_AWS.PNG)
195+
![CD_AWS](attachments/CD_AWS.PNG)
196196

197197
##### Function Name
198198

@@ -216,7 +216,7 @@ For AWS Client Configuration please refer[ https://docs.aws.amazon.com/sdk-for-j
216216

217217
Login to API Gateway and create a *Petstore* API from the swagger definition URL http://petstore.swagger.io/v2/swagger.json alternatively you can use the existing API which is already available in API Gateway. Edit the API, go to *Policies → Traffic Monitoring →* Add *Log Invocation → Select AWS CD under Destination*.
218218

219-
![CD_AWS_API](attachments\CD_AWS_API.png)
219+
![CD_AWS_API](attachments/CD_AWS_API.png)
220220

221221
After all the configuration click Save and Activate the API.
222222

@@ -228,15 +228,15 @@ Open AWS Lambda to check the events. Login to AWS console, then Services → La
228228

229229
In the function overview tab Click Monitor → View logs in CloudWatch.
230230

231-
![CloudWatch](attachments\CloudWatch.PNG)
231+
![CloudWatch](attachments/CloudWatch.PNG)
232232

233233
This will open a new Cloud Watch tab. In the Log streams select any one of the stream. It will list all the log statement along with the data published from API Gateway.
234234

235-
![Lambda_Transaction_Event](attachments\Lambda_Transaction_Event.PNG)
235+
![Lambda_Transaction_Event](attachments/Lambda_Transaction_Event.PNG)
236236

237-
![Lambda_Audit_Log](attachments\Lambda_Audit_Log.PNG)
237+
![Lambda_Audit_Log](attachments/Lambda_Audit_Log.PNG)
238238

239-
![Lambda_Performance_Metrics](attachments\Lambda_Performance_Metrics.PNG)
239+
![Lambda_Performance_Metrics](attachments/Lambda_Performance_Metrics.PNG)
240240

241241
# References
242242

@@ -250,4 +250,4 @@ This will open a new Cloud Watch tab. In the Log streams select any one of the
250250
# Learn more
251251

252252
- For details on usage of *Invoke webMethods IS* policy in versions 10.2 and above, refer [Invoke webMethods IS policy in API Gateway 10.2](https://iwiki.eur.ad.sag/display/RNDWMGDM/Invoke+webMethods+IS+policy+in+API+Gateway+10.2)
253-
- For details on AMQP [AMQP 1.0 support in API Gateway](https://iwiki.eur.ad.sag/display/RNDWMGDM/AMQP+1.0+support+in+API+Gateway)
253+
- For details on AMQP [AMQP 1.0 support in API Gateway](https://iwiki.eur.ad.sag/display/RNDWMGDM/AMQP+1.0+support+in+API+Gateway)

0 commit comments

Comments
 (0)