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.

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

H-plugin synapse workspace diagnostic logs enabled #2076

Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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 exports.js
Original file line number Diff line number Diff line change
Expand Up @@ -1217,6 +1217,7 @@ module.exports = {
'workspaceManagedIdentity' : require(__dirname + '/plugins/azure/synapse/workspaceManagedIdentity.js'),
'synapseWorkspaceAdAuthEnabled' : require(__dirname + '/plugins/azure/synapse/synapseWorkspaceAdAuthEnabled.js'),
'synapseWorkspacPrivateEndpoint': require(__dirname + '/plugins/azure/synapse/synapseWorkspacPrivateEndpoint.js'),
'workspaceDiagnosticLogsEnabled': require(__dirname + '/plugins/azure/synapse/workspaceDiagnosticLogsEnabled.js'),

alphadev4 marked this conversation as resolved.
Show resolved Hide resolved
'apiInstanceManagedIdentity' : require(__dirname + '/plugins/azure/apiManagement/apiInstanceManagedIdentity.js'),
'apiInstanceHasTags' : require(__dirname + '/plugins/azure/apiManagement/apiInstanceHasTags.js'),
Expand Down
5 changes: 5 additions & 0 deletions helpers/azure/api.js
Original file line number Diff line number Diff line change
Expand Up @@ -1277,6 +1277,11 @@ var tertiarycalls = {
properties: ['id'],
url: 'https://management.azure.com/{id}/providers/microsoft.insights/diagnosticSettings?api-version=2021-05-01-preview'
},
listByWorkspaces: {
reliesOnPath: 'synapse.listWorkspaces',
properties: ['id'],
url: 'https://management.azure.com/{id}/providers/microsoft.insights/diagnosticSettings?api-version=2021-05-01-preview'
}
},
backupShortTermRetentionPolicies: {
listByDatabase: {
Expand Down
63 changes: 63 additions & 0 deletions plugins/azure/synapse/workspaceDiagnosticLogsEnabled.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
var async = require('async');
var helpers = require('../../../helpers/azure');

module.exports = {
title: 'Synapse Workspace Diagnostic Logging Enabled',
category: 'AI & ML',
domain: 'Machine Learning',
severity: 'Medium',
description: 'Ensures diagnostic logging is enabled for Synapse workspace.',
alphadev4 marked this conversation as resolved.
Show resolved Hide resolved
more_info: 'Enabling diagnostic logging for Azure Synapse workspace enhances performance monitoring, troubleshooting, and security optimization. This feature captures detailed logs of workspace activities, allowing you to gain insights, identify issues, and maintain the integrity and efficiency of data operations.',
alphadev4 marked this conversation as resolved.
Show resolved Hide resolved
recommended_action: 'Enable diagnostic logging for all Synapse workspaces.',
link: 'https://learn.microsoft.com/en-gb/azure/azure-monitor/essentials/diagnostic-settings',
alphadev4 marked this conversation as resolved.
Show resolved Hide resolved
apis: ['synapse:listWorkspaces', 'diagnosticSettings:listByWorkspaces'],
realtime_triggers: ['microsoftsynapse:workspaces:write','microsoftsynapse:workspaces:delete','microsoftinsights:diagnosticSettings:delete','microsoftinsights:diagnosticSettings:write'],

run: function(cache, settings, callback) {
const results = [];
const source = {};
const locations = helpers.locations(settings.govcloud);

async.each(locations.synapse, function(location, rcb) {
const workspaces = helpers.addSource(cache, source,
['synapse', 'listWorkspaces', location]);

if (!workspaces) return rcb();


alphadev4 marked this conversation as resolved.
Show resolved Hide resolved
if (workspaces.err || !workspaces.data) {
helpers.addResult(results, 3, 'Unable to query Synapse workspaces: ' + helpers.addError(workspaces), location);
return rcb();
}

if (!workspaces.data.length) {
helpers.addResult(results, 0, 'No existing Synapse workspaces found', location);
return rcb();
}

for (let workspace of workspaces.data) {
alphadev4 marked this conversation as resolved.
Show resolved Hide resolved
var diagnosticSettings = helpers.addSource(cache, source,
['diagnosticSettings', 'listByWorkspaces', location, workspace.id]);

if (!diagnosticSettings || diagnosticSettings.err || !diagnosticSettings.data) {
helpers.addResult(results, 3, `Unable to query for Synapse workspace diagnostic settings: ${helpers.addError(diagnosticSettings)}`,
location, workspace.id);
continue;
}

var found = diagnosticSettings.data.find(ds => ds.logs && ds.logs.length);

if (found) {
helpers.addResult(results, 0, 'Synapse workspace has diagnostic logs enabled', location, workspace.id);
} else {
helpers.addResult(results, 2, 'Synapse workspace does not have diagnostic logs enabled', location, workspace.id);
}
}

rcb();
}, function() {
// Global checking goes here
callback(null, results, source);
});
}
};
127 changes: 127 additions & 0 deletions plugins/azure/synapse/workspaceDiagnosticLogsEnabled.spec.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
var expect = require('chai').expect;
var workspaceDiagnosticLogsEnabled = require('./workspaceDiagnosticLogsEnabled');

const workspaces = [
{
type: "Microsoft.Synapse/workspaces",
id: "/subscriptions/123/resourceGroups/rsgrp/providers/Microsoft.Synapse/workspaces/test",
location: "eastus",
name: "test",
}
];


const diagnosticSettings = [
{
id: "/subscriptions/123/resourceGroups/rsgrp/providers/Microsoft.Synapse/workspaces/test",
type: 'Microsoft.Insights/diagnosticSettings',
name: 'test',
location: 'eastus',
kind: null,
tags: null,
eventHubName: null,
metrics: [],
logs: [
{
"category": null,
"categoryGroup": "allLogs",
"enabled": true,
"retentionPolicy": {
"enabled": false,
"days": 0
}
},
{
"category": null,
"categoryGroup": "audit",
"enabled": false,
"retentionPolicy": {
"enabled": false,
"days": 0
}
}
],
logAnalyticsDestinationType: null
}
];

const createCache = (workspaces, ds) => {
const id = workspaces && workspaces.length ? workspaces[0].id : null;
return {
synapse: {
listWorkspaces: {
'eastus': {
data: workspaces
}
}
},
diagnosticSettings: {
listByWorkspaces: {
'eastus': {
[id]: {
data: ds
}
}
}

},
};
};

describe('workspaceDiagnosticLogsEnabled', function() {
describe('run', function() {
it('should give a passing result if no Synapse workspaces are found', function (done) {
const cache = createCache([], null);
workspaceDiagnosticLogsEnabled.run(cache, {}, (err, results) => {
expect(results.length).to.equal(1);
expect(results[0].status).to.equal(0);
expect(results[0].message).to.include('No existing Synapse workspaces found');
expect(results[0].region).to.equal('eastus');
done();
});
});

it('should give unknown result if unable to query for Synapse workspaces', function (done) {
const cache = createCache(null, ['error']);
workspaceDiagnosticLogsEnabled.run(cache, {}, (err, results) => {
expect(results.length).to.equal(1);
expect(results[0].status).to.equal(3);
expect(results[0].message).to.include('Unable to query Synapse workspaces: Unable to obtain data');
expect(results[0].region).to.equal('eastus');
done();
});
});
it('should give unknown result if unable to query for diagnostic settings', function(done) {
const cache = createCache([workspaces[0]], null);
workspaceDiagnosticLogsEnabled.run(cache, {}, (err, results) => {
expect(results.length).to.equal(1);
expect(results[0].status).to.equal(3);
expect(results[0].message).to.include('Unable to query for Synapse workspace diagnostic settings');
expect(results[0].region).to.equal('eastus');
done();
});
});

it('should give passing result if diagnostic logs enabled', function(done) {
const cache = createCache([workspaces[0]], [diagnosticSettings[0]]);
workspaceDiagnosticLogsEnabled.run(cache, {}, (err, results) => {
expect(results.length).to.equal(1);
expect(results[0].status).to.equal(0);
expect(results[0].message).to.include('Synapse workspace has diagnostic logs enabled');
expect(results[0].region).to.equal('eastus');
done();
});
});

it('should give failing result if diagnostic logs not enabled', function(done) {
const cache = createCache([workspaces[0]], [[]]);
workspaceDiagnosticLogsEnabled.run(cache, {}, (err, results) => {
expect(results.length).to.equal(1);
expect(results[0].status).to.equal(2);
expect(results[0].message).to.include('Synapse workspace does not have diagnostic logs enabled');
expect(results[0].region).to.equal('eastus');
done();
});
});
});
});
Loading