diff --git a/src/content/docs/en/pages/devtools/api-graphql/queries/queries.mdx b/src/content/docs/en/pages/devtools/api-graphql/queries/queries.mdx deleted file mode 100644 index ecd4e73af2..0000000000 --- a/src/content/docs/en/pages/devtools/api-graphql/queries/queries.mdx +++ /dev/null @@ -1,492 +0,0 @@ ---- -title: Queries GraphQL API -description: >- - Explore how to effectively use GraphQL API for real-time, aggregated, and - financial data querying with examples, and understand limits and optimization - techniques. -permalink: /documentation/devtools/graphql-api/queries/ -meta_tags: >- - GraphQL API, real-time data, aggregated data, financial data, query - optimization, GraphQL operators, real-time analytics, GraphQL datasets, data - querying, API limits -namespace: documentation_graphql_queries -menu_namespace: graphqlMenu ---- - -Queries are the starting point to begin consulting information as you use a query to request information from a database. The **GraphQL API** relies on queries to fetch values and send the requested data as a response with a similar format in a JSON file. - -The use of queries enables requesting and fetching specific data. This means you can get a response to your request even with a small query if you don't want to see data that isn't essential at that moment. Using queries also means you get faster responses, as the GraphQL API doesn't need to fetch unnecessary amount of data. - -By using queries, your requests and responses also become more organized. Due to GraphQL's ability to adapt, you can make several calls to the API and still receive only the data you requested in an organized JSON result. - -You can use queries for two types of data: - -- **Raw**, using the Real-Time Events GraphQL API. -- **Aggregated**, using the Real-Time Metrics GraphQL API. - -For each type of data, you'll query with different [GraphQL datasets](/en/documentation/devtools/graphql-api/features/#datasets). - -:::tip -See all [GraphQL API limits](/en/documentation/devtools/graphql-api/limits/) to make sure your query is valid. -::: - -### Raw data - -Raw data exhibit your event records without any further processing. They provide detailed information and are helpful when performing deep-dive investigations. - -Here's an example of a raw Real-Time Events GraphQL query: - -```graphql -query HttpQuery { - httpEvents( - limit: 10, - filter: { - tsRange: {begin:"2023-02-14T10:10:10", end:"2023-02-15T10:10:10"} - } - orderBy: [ts_ASC] - ) - { - ts - remoteAddress - requestUri - stacktrace - } -} -``` - -And the response to the query: - -```json -{ - "data": { - "httpEvents": [ - { - "ts": "2023-08-08T10:10:10Z", - "remoteAddress": "xx.xx.xxx.xxx", - "requestUri": "/hello.index/verify", - "stacktrace": "-" - }, - { - "ts": "2023-08-08T10:10:10Z", - "remoteAddress": "yyy.y.yyy.yyyy", - "requestUri": "/hello.index/welcome", - "stacktrace": "-" - }, - { - "ts": "2023-08-08T10:10:10Z", - "remoteAddress": "zzz.zzz.zz.zz", - "requestUri": "/api/verify=pPrt%20", - "stacktrace": "-" - }, - { - "ts": "2023-08-08T10:10:10Z", - "remoteAddress": "xyz.xy.zxy.zxy", - "requestUri": "/helloaspx.index/search", - "stacktrace": "-" - }, - { - "ts": "2023-08-08T10:10:10Z", - "remoteAddress": "zyx.z.yxz.yxz", - "requestUri": "/hello.css/analysis", - "stacktrace": "-" - } - ] - } -} -``` - -To query raw data, it's *mandatory* to inform: - -- A time range interval for all datasets, using either **tsRange** or **tsGt** + **tsLt**. -- Which consulted data should be exhibited. On the presented example, the **ts**, **remoteAddress**, **requestUri**, and **stacktrace** fields were used. - -For example, to perform a **NOT LIKE** query, use the `not` operator with the `Like` or `Ilike` operators to filter out entries that match a certain text. Here's an example: - -```graphql -query HttpQuery { - httpEvents( - limit: 10, - filter: { - tsRange: {begin:"2023-02-14T10:10:10", end:"2023-02-15T10:10:10"}, - not: { - requestUriLike: "%/verify%" - } - } - orderBy: [ts_ASC] - ) - { - ts - remoteAddress - requestUri - stacktrace - } -} -``` - -:::tip -You can also use the **Top X query** feature with the Real-Time Events GraphQL API. It helps to visualize how resources and tools are being used and provide a more detailed analysis of certain conditions that are either more or less commonly used. For example, you can query for “Top 10 Hosts” or “Top 10 Status Codes”. - -Find out more on [How to select Top X queries with GraphQL API](/en/documentation/products/guides/graphql-top-x-query/). -::: - -### Aggregated data - -Aggregated data are a type of structured data that have been clustered. They go through modifications to allow a better analytic processing seeking a segmented analysis, making it easier to visualize even great amount of data over a larger period of time. - -Here's an example of an aggregated Real-Time Metrics GraphQL query: - -```graphql -query HttpQuery { - httpMetrics( - limit: 10, - filter: { - tsRange: {begin:"2022-03-21T10:10:10", end:"2023-09-08T10:10:10"} - } - aggregate: {sum: requestTime} - groupBy: [ts] - orderBy: [ts_ASC] - ) - { - ts - sum - } -} -``` - -And the response to the query: - -```json -{ - "data": { - "httpMetrics": [ - { - "ts": "2022-11-29T00:00:00Z", - "sum": 0.529 - }, - { - "ts": "2022-11-30T00:00:00Z", - "sum": 0.044 - }, - { - "ts": "2023-04-11T00:00:00Z", - "sum": 50.728 - }, - { - "ts": "2023-04-13T00:00:00Z", - "sum": 1.683 - }, - { - "ts": "2023-04-21T00:00:00Z", - "sum": 0.341 - }, - { - "ts": "2023-05-22T00:00:00Z", - "sum": 346.432 - }, - { - "ts": "2023-06-05T00:00:00Z", - "sum": 23.934 - }, - { - "ts": "2023-06-06T00:00:00Z", - "sum": 64.223 - }, - { - "ts": "2023-06-07T00:00:00Z", - "sum": 12.818 - }, - { - "ts": "2023-06-09T00:00:00Z", - "sum": 4.073 - } - ] - } -} -``` - -To query aggregated data, it's *mandatory* to inform: - -- A time range interval for all datasets, using either **tsRange** or **tsGt** + **tsLt**. -- The fields whose information you want to group, using **groupBy**. -- Which consulted data should be shown. On the presented example, the **ts** and **sum** fields were used, in which **sum** represents the response of the **requestTime** aggregation. - -There are also a few options that you must inform through the **aggregate** field in your query: - -| Identifier | Description | -| ---------- | ----------- | -| Count | Determines the total value of records meeting a specific condition. | -| Sum | Returns the sum of the entry values of a column or expression. | -| Max | Returns the maximum value of a determined field of a table according to the established selection criteria. | -| Min | Returns the minimum value of a determined field of a table according to the established selection criteria. | -| Avg | Calculates the arithmetic mean of a set of values in a specific field being consulted. | -| Rate | Used for the imagesProcessed dataset. Obtains the rate of images being processed by second while using Image Processor. | - -Find more information and examples in the [How to query aggregated data with GraphQL API](/en/documentation/products/guides/graphql-aggregated-data/) guide. - -You can run a request with *one of each* of the available options: **count**, **sum**, **max**, **min**, **avg**, and **rate**, as long as each option is only used *once* and each operator aggregates only *one dataset* field at a time. See the following example: - -```graphql -aggregate: { - count: rows, - sum: bytesSent, - avg: requestTime, - max: requestLength, - min: missedData, - rate: requestTime -} -``` - -With the *aggregated model*, you'll receive data according to a time range defined through an *adaptive resolver*. There are three possible intervals to fetch your results: *minute*, *hour*, and *day*. - -| Interval | Description | -| -------- | ----------- | -| Minute | Used for queries in the interval of **up to 3 days**. | -| Hour | Used for queries in the interval of **3 and 60 days**. | -| Day | Used for queries in the interval of **over 60 days**. | - -### Financial data - -Financial data exhibit information of two types: accounted data and billed data. - -Here’s an example of a financial data Accounting GraphQL query: - -```graphql -query accountedData { - accountingDetail( - limit: 10, - filter: { - periodFrom: "2022-06-01", - periodTo: "2022-06-30" - } - ) - { - accounted - clientId - metricSlug - periodFrom - periodTo - } -} -``` - -And the response to the query: - -```json -{ - "data": { - "accountingDetail": [ - { - "accounted": 0, - "clientId": "8437r", - "metricSlug": "load_balancer_data_transferred", - "periodFrom": "2022-06-01", - "periodTo": "2022-06-30" - }, - { - "accounted": 0, - "clientId": "8437r", - "metricSlug": "load_balancer_data_transferred", - "periodFrom": "2022-06-01", - "periodTo": "2022-06-30" - }, - { - "accounted": 0, - "clientId": "8437r", - "metricSlug": "load_balancer_data_transferred", - "periodFrom": "2022-06-01", - "periodTo": "2022-06-30" - }, - { - "accounted": 0, - "clientId": "8437r", - "metricSlug": "load_balancer_data_transferred", - "periodFrom": "2022-06-01", - "periodTo": "2022-06-30" - }, - { - "accounted": 0, - "clientId": "8437r", - "metricSlug": "load_balancer_data_transferred", - "periodFrom": "2022-06-01", - "periodTo": "2022-06-30" - }, - { - "accounted": 0, - "clientId": "8437r", - "metricSlug": "load_balancer_data_transferred", - "periodFrom": "2022-06-01", - "periodTo": "2022-06-30" - }, - { - "accounted": 0, - "clientId": "8437r", - "metricSlug": "compute_time", - "periodFrom": "2022-06-01", - "periodTo": "2022-06-30" - }, - { - "accounted": 139.63, - "clientId": "8437r", - "metricSlug": "compute_time", - "periodFrom": "2022-06-01", - "periodTo": "2022-06-30" - }, - { - "accounted": 0, - "clientId": "8437r", - "metricSlug": "compute_time", - "periodFrom": "2022-06-01", - "periodTo": "2022-06-30" - }, - { - "accounted": 0, - "clientId": "8437r", - "metricSlug": "compute_time", - "periodFrom": "2022-06-01", - "periodTo": "2022-06-30" - } - ] - } -} -``` - -To query financial data, it’s mandatory to inform: - -- Which consulted data should be exhibited. On the presented example, the `accounted`, `clientId`, `metricSlug`, `periodFrom`, and `periodTo` fields were used. - -Different from a raw and an aggregated query, you'll use the `periodFrom` and `periodTo` fields to filter a time range. - -### Usage data - -Usage data exhibit information as accounted data. - -Here’s an example of usage data for Image Processor using Consumption GraphQL API query: - -```graphql -query { - workloadConsumptionMetrics( - filter: { - tsRange: { - begin: "2025-02-01T00:00:00", - end: "2025-03-01T00:00:00", - } - productId: 1441110021 - metricName: "images_processed" - } - aggregate: { - sum: accounted - } - limit: 10000 - groupBy: [clientId, workloadId, productId, metricName] - ) { - clientId - workloadId - productId - metricName - total: sum - } -} -``` - -And the response to the query: - -```json -{ - "data": { - "workloadConsumptionMetrics": [ - { - "clientId": "0000z", - "workloadId": 4829103746, - "productId": 1441110021, - "metricName": "images_processed", - "total": 32 - }, - { - "clientId": "0000z", - "workloadId": 1938475620, - "productId": 1441110021, - "metricName": "images_processed", - "total": 19478 - }, - { - "clientId": "0000z", - "workloadId": 7584931026, - "productId": 1441110021, - "metricName": "images_processed", - "total": 299612 - }, - { - "clientId": "0000z", - "workloadId": 6203849175, - "productId": 1441110021, - "metricName": "images_processed", - "total": 1432 - }, - { - "clientId": "0000z", - "workloadId": 3948571023, - "productId": 1441110021, - "metricName": "images_processed", - "total": 268675 - } - ] - } -} -``` - -To query usage data, it's mandatory to inform: - -Which consulted data should be exhibited. On the presented example, the `accounted`, `clientId`, `workloadId`, `productId`, and `metricName` were used. - - ---- - -## Operators - -Operators are special keys that allow you to customize your query to perform from basic to more complex logical comparisons. You can use them for both the Real-Time Metrics GraphQL API and the Real-Time Events GraphQL API. - -Depending on the operator you use, you'll change the condition you're querying for and receive different results. The following operators can be used with GraphQL: - -| Key | Description | GraphQL Operator | -| --- | ----------- | --------------- | -| eq | Consults data that are an exact match, *equal*, to the specified value. | `Eq` | -| ne | Consults data that are different, *not equal*, from the specified value. | `Ne` | -| like | Consults data that are *like* the specified value, with case-sensitive values. | `Like` | -| ilike | Consults data that are *insensitive like* the specified value, with case-insensitive values. | `Ilike` | -| is_null | Consults data that *are null* or *aren't null* compared to the specified value, using `true` or `false`. | `IsNull` | -| in | Consults data contained in a given list, *in*, the specified value. | `In` | -| not_in | Consults data that aren't in a given list, *not in*, the specified value. | `NotIn` | -| lt | Consults data with values smaller than, *less than*, the specified value. | `Lt` | -| lte | Consults data with values smaller or equal, *less than or equal*, to the specified value. | `Lte` | -| gt | Consults data with values larger, *greater than*, the specified value. | `Gt` | -| gte | Consults data with values larger or equal, *greater than or equal*, to the specified value. | `Gte` | -| range | Consults data that are part of the *range* of the specified values. | `Range` | - -If you're using the `Like` and `Ilike` operators, you must also pass the identifier `%` inside the field in the position you want to use: - -| Identifier position | Description | Example | -| ------------------ | ----------- | -------- | -| End | Any string that starts with the characters. | "Braz%" | -| Beginning | Any string that ends with the characters. | "%ao Paulo" | -| End and beginning | Any string that contains the characters. | "%ttp%" | - -Here are a few examples of fields with an operator: - -| Operator | Example | Description | -| -------- | ------- | ----------- | -| Eq | upstreamCacheStatusEq: "HIT" | Searches everything that matches exactly the `HIT` value in the upstreamCacheStatus field. | -| Ne | geolocCountryNameNe: "Brazil" | Searches everything that isn't `Brazil` in the geolocCountryName field. | -| Like | hostLike: "%mysite.com%" | Searches everything for hosts with the particular `mysite.com` pattern and is *case-sensitive.* | -| Ilike | hostIlike: "%mysite.com%" | Searches everything for hosts with the particular `mysite.com` pattern and is *case-insensitive*. | - -Depending on the [type of field of a dataset](/en/documentation/devtools/graphql-api/features/#datasets) you're querying for, you'll get to use different operators: - -| Field type | Possible operators | -| --- | ----------- | -| String | `Eq`, `Ne`, `Like`, `Ilike`, `In`, `NotIn`, `IsNull` | -| Integer, Float, DateTime | `Eq`, `Lt`, `Lte`, `Gt`, `Gte`, `Ne`, `In`, `NotIn`, `IsNull`, `Range` | - -Discover the essential role of operators in GraphQL queries. Watch the video below: -
- -
diff --git a/src/content/docs/en/pages/main-menu/reference/secure/edge-connector/edge-connector.mdx b/src/content/docs/en/pages/main-menu/reference/secure/edge-connector/edge-connector.mdx index 1e8abf163d..8888b596d0 100644 --- a/src/content/docs/en/pages/main-menu/reference/secure/edge-connector/edge-connector.mdx +++ b/src/content/docs/en/pages/main-menu/reference/secure/edge-connector/edge-connector.mdx @@ -156,12 +156,12 @@ Below are the attributes for the [Connectors API](https://api.azion.com/v4#/oper --- ### Object Storage + + When Object Storage is selected as an origin type, it connects directly with an [Azion Object Storage](/en/documentation/products/store/edge-storage/) bucket where you select the bucket and define the prefix. - When Object Storage is selected as an origin type, it connects directly with an [Azion Object Storage](/en/documentation/products/store/edge-storage/) bucket where you must add the bucket name and prefix. + The bucket name is defined when you [create or modify an Object Storage bucket](/en/documentation/products/guides/create-and-modify-bucket/). When creating a connector, the bucket selector automatically lists your existing buckets and provides a search field to help you find the desired bucket. -The bucket name is defined when you [create or modify an Object Storage bucket](/en/documentation/products/guides/create-and-modify-bucket/). - -The prefix is the path to the folder within the bucket that stores the objects. This field can be left blank if you wish your application's origin to be the root of the bucket. + The prefix is the path to the folder within the bucket that stores the objects. This field can be left blank if you wish your application's origin to be the root of the bucket. #### Attributes diff --git a/src/content/docs/en/pages/store-journey/storage/use-bucket-as-origin.mdx b/src/content/docs/en/pages/store-journey/storage/use-bucket-as-origin.mdx index 5b16d1b3eb..0cad5315c9 100644 --- a/src/content/docs/en/pages/store-journey/storage/use-bucket-as-origin.mdx +++ b/src/content/docs/en/pages/store-journey/storage/use-bucket-as-origin.mdx @@ -172,7 +172,7 @@ Now you need to configure a new **Connector** to link your application to your O 3. In the **General** section, give your connector a unique and descriptive name (e.g., `My Object Storage Connector`). 4. In the **Connector Type** section, select **Object Storage**. 5. In the **Connection Options** section: - - For **Bucket**, select the name of the bucket you created in the previous steps. + - For **Bucket**, select the name of the bucket you created in the previous steps. The bucket selector lists your existing buckets and provides a search field. - For **Prefix**, enter `/src` (or the prefix you used when uploading your objects). 6. Set the **Status** to **Active**. 7. Click the **Save** button. @@ -191,6 +191,10 @@ Once the changes have been made, access `http://xxxxxxxxxx.map.azionedge.net/ind +:::caution +Using Object Storage as an origin directly in **Applications > Origins** is a legacy flow. For migrated accounts, the official and recommended configuration is via **Connectors** and the **Set Connector** behavior. +::: + To facilitate this process, use the [Applications Proxy](/en/documentation/products/guides/edge-application-proxy-template/) template: 1. Access [Azion Console](https://console.azion.com). diff --git a/src/content/docs/pt-br/pages/guias/edge-storage/use-bucket-as-origin/index.mdx b/src/content/docs/pt-br/pages/guias/edge-storage/use-bucket-as-origin/index.mdx index 7e74a82f96..827b66dbec 100644 --- a/src/content/docs/pt-br/pages/guias/edge-storage/use-bucket-as-origin/index.mdx +++ b/src/content/docs/pt-br/pages/guias/edge-storage/use-bucket-as-origin/index.mdx @@ -17,7 +17,11 @@ import Tabs from '~/components/tabs/Tabs' import Code from '~/components/Code/Code.astro' -**Object Storage** da Azion permite que você crie buckets e os use como fonte de conteúdo através de [Origins](/pt-br/documentacao/produtos/build/edge-application/origins/#edge-storage). Dessa forma, você pode tornar público o conteúdo do bucket. +**Object Storage** da Azion permite que você crie buckets e os use como fonte de conteúdo por meio de **Connectors**, que centralizam essa configuração e são a forma oficial e recomendada para vincular um bucket a uma application. + +:::caution[Atenção] +A configuração de Object Storage diretamente em **Applications > Origins** é um fluxo legado. Para contas migradas, use **Connectors** e o comportamento **Set Connector** no **Rules Engine**. +::: Este guia abrange como criar e servir uma aplicação estática recuperada de um bucket do Object Storage usando a [API da Azion](https://api.azion.com) e o [Azion Console](https://console.azion.com). @@ -170,6 +174,10 @@ Para facilitar esse processo, use o template [Applications Proxy](/pt-br/documen O link para sua application permite que você veja como ela fica no navegador. No entanto, leva um certo tempo para propagar e configurá-la nas edge locations da Azion. Pode ser necessário aguardar alguns minutos para que a URL seja ativada e para que a página da aplicação seja efetivamente exibida no navegador. ::: +:::caution[Atenção] +As etapas abaixo descrevem o fluxo legado via **Applications > Origins**. Para contas migradas, a forma oficial e recomendada é criar um **Connector** do tipo **Object Storage** (o seletor de buckets lista automaticamente seus buckets e possui campo de busca) e aplicar o comportamento **Set Connector** no **Rules Engine**. +::: + Agora você precisa configurar uma nova origem tipo **Object Storage** e determinar que sua aplicação deve recuperar o conteúdo do bucket e prefixo que você criou. Para fazer isso: 1. [Acesse o Azion Console](/pt-br/documentacao/produtos/guias/como-acessar-o-azion-console/) > **Applications**. diff --git a/src/content/docs/pt-br/pages/menu-principal/referencia/secure/edge-connector/edge-connector.mdx b/src/content/docs/pt-br/pages/menu-principal/referencia/secure/edge-connector/edge-connector.mdx index 225c647fc4..6530b86241 100644 --- a/src/content/docs/pt-br/pages/menu-principal/referencia/secure/edge-connector/edge-connector.mdx +++ b/src/content/docs/pt-br/pages/menu-principal/referencia/secure/edge-connector/edge-connector.mdx @@ -157,9 +157,9 @@ Abaixo estão os atributos da [Connectors API](https://api.azion.com/v4#/operati ### Object Storage -Quando o Object Storage é selecionado como tipo de origem, ele se conecta diretamente a um bucket do [Azion Object Storage](/pt-br/documentacao/produtos/store/edge-storage/), onde você deve adicionar o bucket name e o prefix. +Quando o Object Storage é selecionado como tipo de origem, ele se conecta diretamente a um bucket do [Azion Object Storage](/pt-br/documentacao/produtos/store/edge-storage/), onde você seleciona o bucket e define o prefix. -O nome do bucket é definido ao [criar ou modificar um bucket Object Storage](/pt-br/documentacao/produtos/guias/criar-e-modificar-um-bucket/). +O nome do bucket é definido ao [criar ou modificar um bucket Object Storage](/pt-br/documentacao/produtos/guias/criar-e-modificar-um-bucket/). Ao criar um connector, o seletor de buckets lista automaticamente os buckets existentes e disponibiliza um campo de busca para facilitar encontrar o bucket desejado. O prefixo é o caminho para a pasta dentro do bucket que armazena os objetos. Este campo pode ser deixado em branco caso deseje que a origem da aplicação seja a raiz do bucket. diff --git a/src/content/docs/pt-br/pages/store-jornada/storage/usar-bucket-como-origem.mdx b/src/content/docs/pt-br/pages/store-jornada/storage/usar-bucket-como-origem.mdx index c55ab60d02..35b8feae87 100644 --- a/src/content/docs/pt-br/pages/store-jornada/storage/usar-bucket-como-origem.mdx +++ b/src/content/docs/pt-br/pages/store-jornada/storage/usar-bucket-como-origem.mdx @@ -200,6 +200,10 @@ Uma vez que as alterações tenham sido feitas, acesse `http://xxxxxxxxxx.map.az +:::caution[Atenção] +As etapas abaixo descrevem o fluxo legado via **Applications > Origins**. Para contas migradas, a forma oficial e recomendada é criar um **Connector** do tipo **Object Storage** (o seletor de buckets lista automaticamente seus buckets e possui campo de busca) e aplicar o comportamento **Set Connector** no **Rules Engine**. +::: + Para facilitar esse processo, use o template [Applications Proxy](/pt-br/documentacao/produtos/guias/edge-application-proxy-template/): 1. Acesse [Azion Console](https://console.azion.com).