Skip to content

Improving the connection setup instructions #2597

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

Merged
merged 2 commits into from
Aug 27, 2025
Merged

Improving the connection setup instructions #2597

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
65a79fa
Improving the connection setup instructions
johnsimons Aug 22, 2025
99f41e2
Improvement based on feedback
johnsimons Aug 26, 2025
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
85 changes: 48 additions & 37 deletions src/Frontend/src/views/throughputreport/setup/ConnectionSetupView.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<script setup lang="ts">
import { onMounted, ref } from "vue";
import { computed, onMounted, ref } from "vue";
import ThroughputConnectionSettings from "@/resources/ThroughputConnectionSettings";
import throughputClient from "@/views/throughputreport/throughputClient";
import { useIsMonitoringEnabled } from "@/composables/serviceServiceControlUrls";
Expand All @@ -16,11 +16,18 @@ const settingsInfo = ref<ThroughputConnectionSettings | null>(null);
onMounted(async () => {
settingsInfo.value = await throughputClient.setting();
});

const needsConfiguration = computed(() => {
const broker = settingsInfo.value?.broker_settings?.length ?? 0;
const monitoring = settingsInfo.value?.monitoring_settings?.length ?? 0;
const serviceControl = settingsInfo.value?.service_control_settings?.length ?? 0;
return broker > 0 || (monitoring > 0 && useIsMonitoringEnabled()) || serviceControl > 0;
});
</script>

<template>
<div class="row">
<p v-if="(settingsInfo?.broker_settings.length ?? 0 > 0) || (!isBrokerTransport && useIsMonitoringEnabled())">
<p v-if="needsConfiguration">
In order for ServicePulse to collect usage data from {{ store.transportNameForInstructions() }} you need to configure the below settings.<br />
There are two configuration options, as environment variables or directly in the
<a href="https://docs.particular.net/servicecontrol/creating-config-file"><code>ServiceControl.exe.config</code></a> file.
Expand Down Expand Up @@ -48,45 +55,49 @@ onMounted(async () => {
</div>
</div>
</template>
<template v-if="!isBrokerTransport && useIsMonitoringEnabled()">
<div class="row configuration">
<div class="col-12">
<h4>ServiceControl Settings</h4>
<p class="nogap">
For more information read the
<a href="https://docs.particular.net/servicecontrol/creating-config-file#usage-reporting-when-using-servicecontrol-licensingcomponentservicecontrolthroughputdataqueue">LicensingComponent/ServiceControlThroughputDataQueue</a> settings
documentation.
</p>
<ConfigurationCode :settings="settingsInfo?.service_control_settings ?? []">
<template #configInstructions>
<div>Paste the settings above into the <code>ServiceControl.exe.config</code> file of the ServiceControl Error instance.</div>
</template>
<template #environmentVariableInstructions>
<div>Execute the above instructions in a terminal to set the environment variables , these variables need to be set for the account under which the ServiceControl Error instance is running.</div>
</template>
</ConfigurationCode>
<template v-if="!isBrokerTransport">
<template v-if="settingsInfo?.service_control_settings.length ?? 0 > 0">
<div class="row configuration">
<div class="col-12">
<h4>ServiceControl Settings</h4>
<p class="nogap">
For more information read the
<a href="https://docs.particular.net/servicecontrol/creating-config-file#usage-reporting-when-using-servicecontrol-licensingcomponentservicecontrolthroughputdataqueue">LicensingComponent/ServiceControlThroughputDataQueue</a> settings
documentation.
</p>
<ConfigurationCode :settings="settingsInfo?.service_control_settings ?? []">
<template #configInstructions>
<div>Paste the settings above into the <code>ServiceControl.exe.config</code> file of the ServiceControl Error instance.</div>
</template>
<template #environmentVariableInstructions>
<div>Execute the above instructions in a terminal to set the environment variables , these variables need to be set for the account under which the ServiceControl Error instance is running.</div>
</template>
</ConfigurationCode>
</div>
</div>
</div>
<div class="row configuration">
<div class="col-12">
<h4>Monitoring Settings</h4>
<p class="nogap">
For more information read the
<a href="https://docs.particular.net/servicecontrol/monitoring-instances/installation/creating-config-file#usage-reporting-monitoringservicecontrolthroughputdataqueue">Monitoring/ServiceControlThroughputDataQueue</a> settings documentation.
</p>
<ConfigurationCode :settings="settingsInfo?.monitoring_settings ?? []" configFileName="ServiceControl.Monitoring.exe.config">
<template #configInstructions>
<div>Paste the settings above into the <code>ServiceControl.Monitoring.exe.config</code> file of the ServiceControl Monitoring instance.</div>
</template>
<template #environmentVariableInstructions>
<div>Execute the above instructions in a terminal to set the environment variables, these variables need to be set for the account under which the ServiceControl Monitoring instance is running.</div>
</template>
</ConfigurationCode>
</template>
<template v-if="useIsMonitoringEnabled() && (settingsInfo?.monitoring_settings.length ?? 0 > 0)">
<div class="row configuration">
<div class="col-12">
<h4>Monitoring Settings</h4>
<p class="nogap">
For more information read the
<a href="https://docs.particular.net/servicecontrol/monitoring-instances/installation/creating-config-file#usage-reporting-monitoringservicecontrolthroughputdataqueue">Monitoring/ServiceControlThroughputDataQueue</a> settings
documentation.
</p>
<ConfigurationCode :settings="settingsInfo?.monitoring_settings ?? []" configFileName="ServiceControl.Monitoring.exe.config">
<template #configInstructions>
<div>Paste the settings above into the <code>ServiceControl.Monitoring.exe.config</code> file of the ServiceControl Monitoring instance.</div>
</template>
<template #environmentVariableInstructions>
<div>Execute the above instructions in a terminal to set the environment variables, these variables need to be set for the account under which the ServiceControl Monitoring instance is running.</div>
</template>
</ConfigurationCode>
</div>
</div>
</div>
</template>
</template>
</template>

<style scoped>
.configuration {
margin-bottom: 15px;
Expand Down
Loading