Esta página se aplica a Apigee y Apigee Hybrid.
Consulta la documentación de
Apigee Edge.
Además de los datos de API habituales recogidos por Apigee, también puede recoger datos personalizados con la política DataCapture. Hay dos pasos principales que debes seguir, tal como se describe en las secciones siguientes:
- Crea un recurso REST de Data Collector.
- Especifica los datos que quieres recoger mediante el elemento
<Collect>
de la política DataCapture.
Crear un recurso REST Data Collector
Para usar la política DataCapture
, primero debes crear un recurso REST
Data Collector. Para ello, envía una solicitud a la API como la siguiente:
curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -X POST -H "content-type:application/json" \ -d ' { "name": "dc_my_custom_data", "description": "Collects data for analysis.", "type": "STRING", }' \ "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/datacollectors"
De esta forma, se crea un recurso llamado dc_my_custom_data
, que puedes usar con la política DataCapture
.
Especificar los datos que se van a recoger
Puede especificar los datos que quiere recoger mediante el elemento
<Collect>
de la política DataCapture. Hay varias formas de hacerlo, como se muestra en la sección Ejemplos de la página de referencia DataCapture. Una de ellas es especificar una variable de flujo, que almacena los datos transferidos en las solicitudes y respuestas de la API. Por ejemplo, puedes recoger los datos que los clientes introducen en un formulario de una página web mediante la variable de flujo message.formparam.param_name.values
, donde param_name
es el nombre de un parámetro del formulario. Supongamos que el formulario
tiene un parámetro llamado payment_amount
. La variable de flujo correspondiente sería message.formparam.payment_amount.values
.
El siguiente código especifica esta variable mediante el atributo ref
del elemento <Collect>
.
<DataCapture name="capturepayment"> <Capture> <DataCollector>dc_my_custom_data</DataCollector> <Collect ref="message.form_param.payment_amount.values" > </Capture> </DataCapture>
Con este ajuste, DataCapture recogerá los datos introducidos en el campo payment_amount
del formulario y los almacenará en una variable llamada dc_my_custom_data
.
Crear un informe personalizado a partir de los datos recogidos con DataCapture
Una vez que haya configurado la recogida de datos con la política DataCapture, podrá usar los datos para crear un informe personalizado siguiendo el procedimiento descrito en Añadir un informe personalizado.
Para ello, cuando seleccione una métrica para el informe, como se muestra en el
paso 4 del procedimiento, elija la variable que tenga el mismo nombre que el recurso REST Data Collector que ha creado para DataCapture (por ejemplo, dc_my_custom_data
).
También puede usar la misma variable como dimensión en un informe personalizado. Como las dimensiones agrupan los datos por los valores de la variable, suele ser preferible que la variable sea una cadena que solo adopte un número limitado de valores.