Skip to content

Commit c360050

Browse files
committed
Changes requested by Ornat
1 parent 3046c23 commit c360050

File tree

5 files changed

+24
-28
lines changed

5 files changed

+24
-28
lines changed

articles/data-explorer/k2bridge.md

Lines changed: 24 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6,47 +6,43 @@ ms.author: orspodek
66
ms.reviewer: guregini
77
ms.service: data-explorer
88
ms.topic: conceptual
9-
ms.date: 03/11/2020
9+
ms.date: 03/12/2020
1010
---
1111

1212
# Visualize data from Azure Data Explorer in Kibana with the K2Bridge open-source connector
1313

14-
K2Bridge (Kibana-Kusto Bridge) enables you to use Azure Data Explorer as the data source and to visualize that data in Kibana. K2Bridge is an open-source containerized application which acts as a proxy between a Kibana instance and an Azure Data Explorer cluster. This article describes how to use K2Bridge to create that connection.
14+
K2Bridge (Kibana-Kusto Bridge) enables you to use Azure Data Explorer as the data source and to visualize that data in Kibana. K2Bridge is an [open-source](https://github.com/microsoft/K2Bridge) containerized application which acts as a proxy between a Kibana instance and an Azure Data Explorer cluster. This article describes how to use K2Bridge to create that connection.
1515

1616
K2Bridge translates Kibana queries to Kusto Query Language (KQL) and sends the Azure Data Explorer results back to Kibana.
1717

1818
![chart](media/k2bridge/k2bridge-chart.png)
1919

20-
K2Bridge supports Kibanas Discover tab, where you can:
20+
K2Bridge supports Kibana's Discover tab, where you can:
2121
* Search and explore the data
2222
* Filter results
2323
* Add or remove fields in the results grid
2424
* View record content
2525
* Save and share searches
2626

27-
The image below shows a Kibana instance bound to Azure Data Explorer by K2Bridge. The search experience is in Kibana, and the overall look and feel is as usual.
27+
The image below shows a Kibana instance bound to Azure Data Explorer by K2Bridge. The user experience in Kibana is unchanged.
2828

2929
[![Kibana Page](media/k2bridge/k2bridge-kibana-page.png)](media/k2bridge/k2bridge-kibana-page.png#lightbox)
3030

31-
The K2Bridge connector source code is on [GitHub](https://github.com/microsoft/K2Bridge).
32-
3331
## Prerequisites
3432

3533
Before you can visualize data from Azure Data Explorer in Kibana, have the following ready:
3634

3735
* [Helm V3](https://github.com/helm/helm#install), the Kubernetes package manager
38-
* Azure Kubernetes Service (AKS) cluster, or any other Kubernetes cluster (version 1.14 to version 1.16 have been tested and verified). If you need an AKS cluster, see the AKS Quickstart guide [using the Azure CLI](https://docs.microsoft.com/azure/aks/kubernetes-walkthrough) or [using the Azure portal](https://docs.microsoft.com/azure/aks/kubernetes-walkthrough-portal)
39-
* An Azure Data Explorer cluster, including:
36+
* Azure Kubernetes Service (AKS) cluster, or any other Kubernetes cluster (version 1.14 to version 1.16 have been tested and verified). If you need an AKS cluster, see Deploy an AKS cluster [using the Azure CLI](https://docs.microsoft.com/azure/aks/kubernetes-walkthrough) or [using the Azure portal](https://docs.microsoft.com/azure/aks/kubernetes-walkthrough-portal)
37+
* An [Azure Data Explorer cluster](create-cluster-database-portal.md), including:
4038
* The Azure Data Explorer cluster's URL
4139
* The database name
4240

43-
For more information, see: [Create an Azure Data Explorer cluster and database](create-cluster-database-portal.md)
4441
* An Azure AD service principal authorized to view data in Azure Data Explorer, including:
4542
* The Client ID
4643
* The Client Secret
4744

48-
> [!Note]
49-
> A service principal with 'Viewer' permission is recommended. It is discouraged to use higher permissions.
45+
A service principal with 'Viewer' permission is recommended. It is discouraged to use higher permissions.
5046

5147
* [Set the cluster's view permissions for the Azure AD service principal](https://docs.microsoft.com/azure/data-explorer/manage-database-permissions#manage-permissions-in-the-azure-portal).
5248

@@ -103,7 +99,7 @@ By default, K2Bridges's Helm chart references a publicly available image located
10399
helm install k2bridge charts/k2bridge -n k2bridge --set image.repository=$REPOSITORY_NAME/$CONTAINER_NAME --set settings.adxClusterUrl="$ADX_URL" --set settings.adxDefaultDatabaseName="$ADX_DATABASE" --set settings.aadClientId="$ADX_CLIENT_ID" --set settings.aadClientSecret="$ADX_CLIENT_SECRET" --set settings.aadTenantId="$ADX_TENANT_ID" [--set image.tag=latest] [--set privateRegistry="$IMAGE_PULL_SECRET_NAME"] [--set settings.collectTelemetry=$COLLECT_TELEMETRY]
104100
```
105101
106-
The complete set of configuration options is [here](https://github.com/microsoft/K2Bridge/blob/master/docs/configuration.md).
102+
In [Configuration](https://github.com/microsoft/K2Bridge/blob/master/docs/configuration.md) you can find the complete set of configuration options.
107103
108104
1. The command output will suggest the next Helm command to run to deploy Kibana. Optionally, run:
109105
@@ -119,17 +115,17 @@ By default, K2Bridges's Helm chart references a publicly available image located
119115
120116
1. Expose Kibana to the end users. There are multiple methods to do so. The method you use largely depends on your use case.
121117
122-
Example:
118+
For example:
123119
124120
Expose the service as a LoadBalancer service. To do so, add the following parameter to the K2Bridge Helm install command ([above](#install-k2bridge-chart)):
125121
126-
`--set service.type=LoadBalancer`
127-
128-
Then run:
122+
`--set service.type=LoadBalancer`
123+
124+
Then run:
129125
130-
```bash
131-
kubectl get service -w -n k2bridge
132-
```
126+
```bash
127+
kubectl get service -w -n k2bridge
128+
```
133129
The output should look like:
134130
135131
```bash
@@ -144,7 +140,7 @@ In a new Kibana instance:
144140
1. Navigate to Management.
145141
1. Select **Index Patterns**.
146142
1. Create an index pattern.
147-
The name of the index must **exactly match** the table name or function name, without an asterisk. You can copy the relevant line from the list.
143+
The name of the index must exactly match the table name or function name, without an asterisk. You can copy the relevant line from the list.
148144
149145
> [!Note]
150146
> To run on other Kubernetes providers, change the Elasticsearch storageClassName in `values.yaml` to fit the one suggested by the provider.
@@ -159,33 +155,33 @@ When Azure Data Explorer is configured as a data source for Kibana, you can use
159155
160156
![Select an index pattern](media/k2bridge/k2bridge-select-an-index-pattern.png)
161157
162-
1. If your data has a time-filter field, you can specify the time range. At the upper-right of the page, set a **time filter**. By default, Discover shows data for the last 15 minutes.
158+
1. If your data has a time-filter field, you can specify the time range. At the upper-right of the page, set a time filter. By default, Discover shows data for the last 15 minutes.
163159
164160
![Time filter](media/k2bridge/k2bridge-time-filter.png)
165161
166-
1. The results table shows the first 500 records. You can **expand a document** to examine its field data in either JSON or table formats.
162+
1. The results table shows the first 500 records. You can expand a document to examine its field data in either JSON or table formats.
167163
168164
![Expand a record](media/k2bridge/k2bridge-expand-record.png)
169165
170-
1. By default, the results table includes columns for the document _source and the time field (if it exists). You can **choose specific columns** to be added to the results table by selecting **add** next to the field name in the left sidebar.
166+
1. By default, the results table includes columns for the document _source and the time field (if it exists). You can choose specific columns to be added to the results table by selecting **add** next to the field name in the left sidebar.
171167
172168
![Specific columns](media/k2bridge/k2bridge-specific-columns.png)
173169
174-
1. In the query bar, you can **search the data** by:
170+
1. In the query bar, you can search the data by:
175171
* Entering a search term
176172
* Using the Lucene query syntax.
177-
Examples:
173+
For example:
178174
* Search "error" to find all the records that contain this value.
179175
* Search for "status: 200", to get all the records with a status value of 200.
180176
* Using logical operators (AND, OR, NOT)
181177
* Using wildcards (asterisk " \* " or question mark "?")
182-
Example:
178+
For example:
183179
* The query `"destination_city: L*"` will match records where the destination city value starts with "l" (K2Bridge is not case-sensitive).
184180
185181
![Run query](media/k2bridge/k2bridge-run-query.png)
186182
187183
> [!Tip]
188-
> You can find more search rules and logic [here](https://github.com/microsoft/K2Bridge/blob/master/docs/searching.md).
184+
> In [Searching](https://github.com/microsoft/K2Bridge/blob/master/docs/searching.md), you can find more search rules and logic.
189185
190186
1. To filter your search results, use the **field list** on the right sidebar of the page.
191187
The field list is where you can see:
@@ -202,6 +198,6 @@ When Azure Data Explorer is configured as a data source for Kibana, you can use
202198
203199
![Table list](media/k2bridge/k2bridge-table-list.png)
204200
205-
1. To **save** and **share** your search, on the top menu bar, select either **Save** or **Share**.
201+
1. Select either to **Save** or **Share** your search.
206202
207203
![Save search](media/k2bridge/k2bridge-save-search.png)
53 Bytes
Loading
88 Bytes
Loading
62 Bytes
Loading
1 Byte
Loading

0 commit comments

Comments
 (0)