LinkedIn
Twitter
Hello @shefali!
There is a way of making this work. I see you are using message templates here, such as escapeJSON(). You can find many additional message templates available to modify the behaviour and contents of variables or runtime data. There is a "Null-coalescing function" template you can find that will be able to help in this specific scenario. You can find the documentation here: #null-coalescing-function.
I created a simple example to achieve something like this with the same message logging policy:
A small difference is to actually apply the first function prior to the construction of the log object, you can also apply it in the extraction of the variables I noticed you might be doing for the first body.
Creating my variable for the body with escapeJSON Template:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage continueOnError="false" enabled="true" name="am-extract-request-body">
<DisplayName>am-extract-request-body</DisplayName>
<Properties/>
<AssignVariable>
<Name>request_body</Name>
<Template>{escapeJSON(request.content)}</Template>
<Value>ErrorOnCopy</Value>
</AssignVariable>
<IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
<AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>
Setting my variable in the message logging policy applying the second template:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<MessageLogging continueOnError="false" enabled="true" name="ml-ingest-log">
<DisplayName>ml-ingest-log</DisplayName>
<CloudLogging>
<LogName>projects/------/logs/apigee</LogName>
<Message contentType="application/json">{
"timestamp": "{crypto.dateFormat('YYYY-MM-dd HH:mm:ss.SSS')}",
"organization": "{organization.name}",
"network.client.ip": "{client.ip}",
"message_id": "{messageid}",
"env": "{environment.name}",
"message": "{firstnonnull(request_body, 'this request had no request body')}"
}</Message>
</CloudLogging>
</MessageLogging>
The way this template works is that it will start looking for a non null variable left to right and pick the first one it gets.
I think that with a small refactor you can make this work for all logging scenarios in you api.
You could do something like this:
<CloudLogging>
<LogName>projects/apigee-dev/logs/apigee.googleapis.com%2Fproxy-logging-events</LogName>
<Message contentType="application/json">
{
"apiProxy": "{apiproxy.name}",
"apiProxyRevision": "{apiproxy.revision}",
"inputPayload": "{firstnonnull(requestPayload, 'other variable or literal')}",
"responsePayload": "{firstnonnull(calloutVIESResponse.content, calloutXPayload.content)}",
"responseType": "viesPayload/xPayload",
"responseSentToClient": {httpResponse}
}
</Message>
You mentioned that there are 2 object where you expect in different scenarios a payload. So:
- Scenario 1: You enter the conditional flow where viesPayload is present.
- Scenario 2: You enter the conditional flow where xPayload
What I suggest is creating a single property such as the one in the example above with responsePayload and use the firstnonnull function here to specify both json object. The policy will populate the first it gets as a non null. Additionally you might want to capture the type of response payload you are logging, so I added a responseType. You can use the proxy path suffix flow variable to get some visibility or use it as reference for variable population.
On an additional note, nesting functions is not supported, so you will have to apply the escapeJSON() function prior to creating the log object.
I hope this helps! Let me know.
@dchiesa1 : I think the jsonPayload is from the structured logging as I read from this page:
https://cloud.google.com/logging/docs/structured-logging
and here is the snippet from the above doc:
This document discusses the concept of structured logging and the methods for adding structure to log entry payload fields. When the log payload is formatted as a JSON object and that object is stored in the jsonPayload field, the log entry is called a structured log.
The issue here is : if you see the below screenshot, the trace query is formed like this and it gives only one result.
But the load balancer trace is not visible because that works like this:
so basically I want to know if I can add trace field outside the message tag so that it comes outside of jsonPayload structure.
<CloudLogging>
<LogName>projects/systems-apigee-dev/logs/apigee.googleapis.com%2Fproxy-logging-events</LogName>
<Message contentType="application/json">
{
"apigeeResourceName": "{apiproxy.name}",
"apiProxyRevision": "{apiproxy.revision}",
"inputPayload": "{escapeJSON(requestPayload)}",
"viesPayload": "{escapeJSON(calloutVIESResponse.content)}",
"responseSentToClient": "{escapeJSON(httpResponse)}",
"taxIdPayload": "{escapeJSON(calloutValidateResponse.content)}",
"responseErrorSentToClient":"{escapeJSON(httpErrorResponse)}",
"messageId":"{messageid}"
}
</Message>
<Labels>
<Label>
<Key>apiProxy</Key>
<Value>jsonUpload</Value>
</Label>
</Labels>
<ResourceType>api</ResourceType>
