Solved: Simulate VerifyAPIKey analytics - Page 2

pietjacobs · 07-20-2022 01:44 AM

Hi all,

I am wondering if it is possible to simulate the analytics behavior that happens when you use the VerifyAPIKey policy.

The situation is that our Apigee does not know the clients, therefore we cannot perform the VerifyAPIKey and populate the default analytics dashboards on the UI. However what we would like to do is populate our analytics dashboards anyway with those values, except they are not coming from the VerifyAPIKey policy. We want to populate those analytics with data retrieved from an LDAP lookup.

So instead by using the StatisticsCollector policy, the idea is to populate the same analytics variables that the VerifyAPIKey populates (this is based on this article https://www.googlecloudcommunity.com/gc/Apigee/StatisticCollector-or-VerifyAPIKey-not-setting-flow-v...)

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<StatisticsCollector async="false" continueOnError="false" enabled="true" name="SC-Record-Analytics">
    <DisplayName>SC-Record-Analytics</DisplayName>
    <Properties/>
    <Statistics>
        <Statistic name="apiproduct.name" ref="in.SF-Lib-Record-Analytics.API-Product" type="STRING">defaultValue</Statistic>
        <Statistic name="developer.app.name" ref="in.SF-Lib-Record-Analytics.Developer-App" type="STRING">defaultValue</Statistic>
        <Statistic name="client_id" ref="in.SF-Lib-Record-Analytics.Client-ID" type="STRING">defaultValue</Statistic>
        <Statistic name="developer.email" ref="in.SF-Lib-Record-Analytics.Developer" type="STRING">defaultValue</Statistic>
        <Statistic name="developer.id" ref="in.SF-Lib-Record-Analytics.Developer" type="STRING">defaultValue</Statistic>
    </Statistics>
</StatisticsCollector>

However this does not seem to be fully working, as e.g. the Traffic Composition dashboard just shows this:

It appears the default value has been set properly in the past, when I pass it as a variable it seems to fail (the variables are correct though...).

Anyone else have any experience with this?

Thanks!
Kind regards, Piet

pietjacobs

It turns out that there are 2 main requirements before this can work (only tested in OPDK 4.51):

You must have configured at least 1 (mock) developer + api product + app
The Statistics Collector Policy was unhappy with the syntax of my variables (this is a naming convention that we employ), never had any issue with this before. But changing the variables to something like this and it worked:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<StatisticsCollector async="false" continueOnError="false" enabled="true" name="SC-Record-Analytics">
    <DisplayName>SC-Record-Analytics</DisplayName>
    <Properties/>
    <Statistics>
        <Statistic name="api_product" type="string" ref="AnalyticsProduct">defaultValue</Statistic>
        <Statistic name="developer_app" type="string" ref="AnalyticsDeveloperApp">defaultValue</Statistic>
        <Statistic name="client_id" type="string" ref="AnalyticsClientID">defaultValue</Statistic>
        <Statistic name="developer" type="string" ref="AnalyticsDeveloper">defaultValue</Statistic>
        <Statistic name="developer_email" type="string" ref="AnalyticsDeveloper">defaultValue</Statistic>
    </Statistics>
</StatisticsCollector>

The following documentation states however that this is something you "cannot do".
So we are still uncertain if this approach is safe for long-term...

View solution in original post