Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add JSON5 parsing capabilities for integration configs #1732

Merged
merged 13 commits into from
May 2, 2024
Merged

Add JSON5 parsing capabilities for integration configs #1732

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
71597f5
update live mv table name (#1725)
YANG-DB Apr 19, 2024
7317260
Integrated JSON5
devesh-2002 Apr 20, 2024
2cde9da
json_data_adaptor
devesh-2002 Apr 20, 2024
cdba076
Added tests for JSON5
devesh-2002 Apr 25, 2024
3ef144d
Updated integration configs to json5
devesh-2002 Apr 30, 2024
efbc0f7
Revert "update live mv table name (#1725)"
devesh-2002 Apr 30, 2024
4cba89d
Updated filename
devesh-2002 Apr 30, 2024
3e0a7f7
Delete t --count 5c930019..fe64d023
devesh-2002 Apr 30, 2024
1a415cb
Merge branch 'main' into devesh1
Swiddis Apr 30, 2024
d1e2ab8
Updated some integrations
devesh-2002 May 1, 2024
e9293f7
Merge branch 'main' into devesh1
devesh-2002 May 1, 2024
f43c66c
Merge branch 'main' into devesh1
Swiddis May 1, 2024
3b12a45
Merge branch 'main' into devesh1
Swiddis May 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
"antlr4ts": "^0.5.0-alpha.4",
"cypress-multi-reporters": "^1.6.3",
"cypress-parallel": "^0.13.0",
"json5": "^2.2.3",
"mime": "^3.0.0",
"mocha": "10.1.0",
"performance-now": "^2.1.0",
Expand Down
118 changes: 40 additions & 78 deletions server/adaptors/integrations/__data__/repository/apache/apache-1.0.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,90 +1,52 @@
{
"name": "apache",
"version": "1.0.0",
"displayName": "Apache Access Logs",
"description": "Insights on applications using the standard Apache access log format.",
"license": "Apache-2.0",
"type": "logs_apache",
"labels": ["Observability", "Logs", "Flint S3"],
"author": "OpenSearch",
"sourceUrl": "https://github.com/opensearch-project/dashboards-observability/tree/main/server/adaptors/integrations/__data__/repository/apache/info",
"workflows": [
{
"name": "queries",
"label": "Queries (recommended)",
"description": "Tables and pre-written queries for quickly getting insights on your data.",
"enabled_by_default": true
},
{
"name": "dashboards",
"label": "Dashboards & Visualizations",
"description": "Dashboards and indices that enable you to easily visualize important metrics.",
"enabled_by_default": false
name: "apache",
version: "1.0.0",
displayName: "Apache Access Logs",
description: "Insights on applications using the standard Apache access log format.",
license: "Apache-2.0",
type: "logs_apache",
labels: ["Observability", "Logs", "Flint S3"],
author: "OpenSearch",
sourceUrl: "https://github.com/opensearch-project/dashboards-observability/tree/main/server/adaptors/integrations/__data__/repository/apache/info",
workflows: [
{
name: "queries",
label: "Queries (recommended)",
description: "Tables and pre-written queries for quickly getting insights on your data.",
enabled_by_default: true
},
{
name: "dashboards",
label: "Dashboards & Visualizations",
description: "Dashboards and indices that enable you to easily visualize important metrics.",
enabled_by_default: false
}
],
"statics": {
"logo": {
"annotation": "Apache Logo",
"path": "logo.png"
statics: {
logo: {
annotation: "Apache Logo",
path: "logo.png"
},
"gallery": [
gallery: [
{
"annotation": "Apache Dashboard",
"path": "dashboard1.png"
annotation: "Apache Dashboard",
path: "dashboard1.png"
}
]
},
"components": [
{
"name": "communication",
"version": "1.0.0"
},
{
"name": "http",
"version": "1.0.0"
},
{
"name": "logs_apache",
"version": "1.0.0"
}
components: [
{ name: "communication", version: "1.0.0" },
{ name: "http", version: "1.0.0" },
{ name: "logs_apache", version: "1.0.0" }
],
"assets": [
{
"name": "apache",
"version": "1.0.0",
"extension": "ndjson",
"type": "savedObjectBundle",
"workflows": ["dashboards"]
},
{
"name": "example_queries",
"version": "1.0.0",
"extension": "ndjson",
"type": "savedObjectBundle",
"workflows": ["queries"]
},
{
"name": "create_table",
"version": "1.0.0",
"extension": "sql",
"type": "query"
},
{
"name": "create_skipping_index",
"version": "1.0.0",
"extension": "sql",
"type": "query",
"workflows": ["queries"]
},
{
"name": "create_mv",
"version": "1.0.0",
"extension": "sql",
"type": "query",
"workflows": ["dashboards"]
}
assets: [
{ name: "apache", version: "1.0.0", extension: "ndjson", type: "savedObjectBundle", workflows: ["dashboards"] },
{ name: "example_queries", version: "1.0.0", extension: "ndjson", type: "savedObjectBundle", workflows: ["queries"] },
{ name: "create_table", version: "1.0.0", extension: "sql", type: "query" },
{ name: "create_skipping_index", version: "1.0.0", extension: "sql", type: "query", workflows: ["queries"] },
{ name: "create_mv", version: "1.0.0", extension: "sql", type: "query", workflows: ["dashboards"] }
],
"sampleData": {
"path": "sample.json"
sampleData: {
path: "sample.json"
}
}
122 changes: 42 additions & 80 deletions server/adaptors/integrations/__data__/repository/nginx/nginx-1.0.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,94 +1,56 @@
{
"name": "nginx",
"version": "1.0.0",
"displayName": "Nginx",
"description": "Analyze Nginx access logs.",
"license": "Apache-2.0",
"type": "logs",
"labels": ["Observability", "Logs", "Flint S3"],
"author": "OpenSearch",
"sourceUrl": "https://github.com/opensearch-project/dashboards-observability/tree/main/server/adaptors/integrations/__data__/repository/nginx/info",
"workflows": [
{
"name": "queries",
"label": "Queries (recommended)",
"description": "Tables and pre-written queries for quickly getting insights on your data.",
"enabled_by_default": true
},
{
"name": "dashboards",
"label": "Dashboards & Visualizations",
"description": "Dashboards and indices that enable you to easily visualize important metrics.",
"enabled_by_default": false
name: "nginx",
version: "1.0.0",
displayName: "Nginx",
description: "Analyze Nginx access logs.",
license: "Apache-2.0",
type: "logs",
labels: ["Observability", "Logs", "Flint S3"],
author: "OpenSearch",
sourceUrl: "https://github.com/opensearch-project/dashboards-observability/tree/main/server/adaptors/integrations/__data__/repository/nginx/info",
workflows: [
{
name: "queries",
label: "Queries (recommended)",
description: "Tables and pre-written queries for quickly getting insights on your data.",
enabled_by_default: true
},
{
name: "dashboards",
label: "Dashboards & Visualizations",
description: "Dashboards and indices that enable you to easily visualize important metrics.",
enabled_by_default: false
}
],
"statics": {
"logo": {
"annotation": "NginX Logo",
"path": "logo.svg"
statics: {
logo: {
annotation: "NginX Logo",
path: "logo.svg"
},
"gallery": [
gallery: [
{
"annotation": "NginX Dashboard",
"path": "dashboard1.png"
annotation: "NginX Dashboard",
path: "dashboard1.png"
},
{
"annotation": "NginX Dashboard view",
"path": "dashboard2.png"
annotation: "NginX Dashboard view",
path: "dashboard2.png"
}
]
},
"components": [
{
"name": "communication",
"version": "1.0.0"
},
{
"name": "http",
"version": "1.0.0"
},
{
"name": "logs",
"version": "1.0.0"
}
components: [
{ name: "communication", version: "1.0.0" },
{ name: "http", version: "1.0.0" },
{ name: "logs", version: "1.0.0" }
],
"assets": [
{
"name": "nginx",
"version": "1.0.0",
"extension": "ndjson",
"type": "savedObjectBundle",
"workflows": ["dashboards"]
},
{
"name": "create_table",
"version": "1.0.0",
"extension": "sql",
"type": "query"
},
{
"name": "create_skipping_index",
"version": "1.0.0",
"extension": "sql",
"type": "query",
"workflows": ["queries"]
},
{
"name": "create_mv",
"version": "1.0.0",
"extension": "sql",
"type": "query",
"workflows": ["dashboards"]
},
{
"name": "example_queries",
"version": "1.0.0",
"extension": "ndjson",
"type": "savedObjectBundle",
"workflows": ["queries"]
}
assets: [
{ name: "nginx", version: "1.0.0", extension: "ndjson", type: "savedObjectBundle", workflows: ["dashboards"] },
{ name: "create_table", version: "1.0.0", extension: "sql", type: "query" },
{ name: "create_skipping_index", version: "1.0.0", extension: "sql", type: "query", workflows: ["queries"] },
{ name: "create_mv", version: "1.0.0", extension: "sql", type: "query", workflows: ["dashboards"] },
{ name: "example_queries", version: "1.0.0", extension: "ndjson", type: "savedObjectBundle", workflows: ["queries"] }
],
"sampleData": {
"path": "sample.json"
sampleData: {
path: "sample.json"
}
}
3 changes: 2 additions & 1 deletion server/adaptors/integrations/repository/fs_data_adaptor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

import * as fs from 'fs/promises';
import path from 'path';
import JSON5 from 'json5';
import { CatalogDataAdaptor, IntegrationPart } from './catalog_data_adaptor';
import { tryParseNDJson } from './utils';

Expand Down Expand Up @@ -45,7 +46,7 @@ export class FileSystemDataAdaptor implements CatalogDataAdaptor {
}
// First try to parse as JSON, then NDJSON, then fail.
try {
const parsed = JSON.parse(content);
const parsed = JSON5.parse(content);
return { ok: true, value: parsed };
} catch (err) {
const parsed = await tryParseNDJson(content);
Expand Down
5 changes: 5 additions & 0 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2007,6 +2007,11 @@ json-stringify-safe@~5.0.1:
resolved "https://registry.yarnpkg.com/json-stringify-safe/-/json-stringify-safe-5.0.1.tgz#1296a2d58fd45f19a0f6ce01d65701e2c735b6eb"
integrity sha512-ZClg6AaYvamvYEE82d3Iyd3vSSIjQ+odgjaTzRuO3s7toCdFKczob2i0zCh7JE8kWn17yvAWhUVxvqGwUalsRA==

json5@^2.2.3:
version "2.2.3"
resolved "https://registry.yarnpkg.com/json5/-/json5-2.2.3.tgz#78cd6f1a19bdc12b73db5ad0c61efd66c1e29283"
integrity sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==

jsonfile@^6.0.1:
version "6.1.0"
resolved "https://registry.yarnpkg.com/jsonfile/-/jsonfile-6.1.0.tgz#bc55b2634793c679ec6403094eb13698a6ec0aae"
Expand Down
Loading