Skip to content
This repository was archived by the owner on Apr 21, 2026. It is now read-only.

Commit f97e47f

Browse files
author
dpatanin
committed
Merge branch 'gh-source' into frontpage-produktkarton
2 parents 770111f + 17207d6 commit f97e47f

2 files changed

Lines changed: 65 additions & 0 deletions

File tree

src/pages/telemetry/index.js

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
import React from "react";
2+
import { graphql } from "gatsby";
3+
import SEO from "../../components/SEO";
4+
import Layout from "../../components/Layout";
5+
6+
const TelemetryPage = (props) => {
7+
const html = props.data.markdownRemark.html;
8+
return (
9+
<Layout bodyClass="page-telemetry">
10+
<SEO title="Telemetry" />
11+
<div id="content">
12+
<div className="container" id="integration-doc">
13+
<div className="content" dangerouslySetInnerHTML={{ __html: html }} />
14+
</div>
15+
</div>
16+
</Layout>
17+
);
18+
};
19+
20+
export const query = graphql`
21+
query Telemetry {
22+
markdownRemark(
23+
fileAbsolutePath: { regex: "/src/pages/telemetry/telemetry/" }
24+
) {
25+
html
26+
}
27+
}
28+
`;
29+
30+
export default TelemetryPage;

src/pages/telemetry/telemetry.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: "telemetry"
3+
path: "/telemetry"
4+
date: 2020-08-27 14:00:00
5+
---
6+
7+
# secureCodeBox Telemetry Data
8+
9+
The secureCodeBox Operator collects and submits anonymized data to give the development team a vague overview on how much the secureCodeBox is actually used.
10+
11+
## Datapoints Collected:
12+
13+
The total number of datapoints collected is extremely small, and they are individually evaluated to ensure that the submitted data is as anonymous as possible.
14+
15+
- Installed version of the secureCodeBox Operator (e.g. `v2.0.0`)
16+
- List of installed ScanTypes across all kubernetes Namespaces: (e.g. `['nmap', 'zap-baseline']`). Unofficial ScanTypes are reported as `other`, to avoid submission of confidential data.
17+
18+
## Collection Interval
19+
20+
The data is submitted every 24 hours. When the Operator starts, the first data-point is submitted one hour after the start, to give users the opportunity to disable the telemetry data submission before the first datapoints are send.
21+
22+
## Disabling Telemetry Data Submission
23+
24+
The collection of telemetry data can be completely disabled by setting the `telemetryEnabled` to `false`, e.g:
25+
26+
```bash
27+
helm install securecodebox-operator secureCodeBox/operator --set="telemetryEnabled=false"
28+
```
29+
30+
## Telemetry Code
31+
32+
The entire code for both the telemetry backend and frontend is open-source and linked below.
33+
34+
- Telemetry Client used in secureCodeBox Operator: [telemetry client](https://github.com/secureCodeBox/secureCodeBox-v2/blob/master/operator/internal/telemetry/telemetry.go)
35+
- Telemetry Backend: [telemetry backend](https://github.com/secureCodeBox/telemetry)

0 commit comments

Comments
 (0)