@sailfish-ai/sf-veritas 0.1.1 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -8
- package/dist/sf-veritas.cjs +7 -7
- package/dist/sf-veritas.mjs +290 -289
- package/dist/types/setupConfig.d.ts +8 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,11 +5,14 @@ Middleware for JavaScript and TypeScript to intercept API requests, console stat
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
7
|
To install from our repository, you need to configure your `npm` or `yarn` registry settings. Here's how to do it:
|
|
8
|
+
|
|
8
9
|
#### npmrc Configuration
|
|
10
|
+
|
|
9
11
|
```bash
|
|
10
12
|
// Add this to your .npmrc
|
|
11
|
-
@sailfishai:registry=https://us-
|
|
13
|
+
@sailfishai:registry=https://us-npm.pkg.dev/futureself-world/sailfishai-npm/
|
|
12
14
|
```
|
|
15
|
+
|
|
13
16
|
#### Install the Package
|
|
14
17
|
|
|
15
18
|
```bash
|
|
@@ -19,13 +22,12 @@ yarn add @sailfish/recorder
|
|
|
19
22
|
```
|
|
20
23
|
|
|
21
24
|
## Usage and Example Integration
|
|
22
|
-
---
|
|
23
|
-
|
|
24
25
|
|
|
26
|
+
---
|
|
25
27
|
|
|
26
28
|
#### Arguments/Parameters
|
|
27
29
|
|
|
28
|
-
1
|
|
30
|
+
1. Below are the configuration parameters for @sailfish/recorder. These options are passed as an object to the setupInterceptors function. All parameters are non-mandatory.
|
|
29
31
|
|
|
30
32
|
- `serviceIdentifier`: string
|
|
31
33
|
|
|
@@ -48,6 +50,7 @@ yarn add @sailfish/recorder
|
|
|
48
50
|
- Specify packages or modules for capturing local variable values during errors or exceptions. Use ['__all__'] to capture local variables globally.`
|
|
49
51
|
|
|
50
52
|
#### Example of setup
|
|
53
|
+
|
|
51
54
|
Here’s an example setup in a Node.js or TypeScript project:
|
|
52
55
|
|
|
53
56
|
```js
|
|
@@ -56,14 +59,13 @@ const app = express();
|
|
|
56
59
|
const port = 3000;
|
|
57
60
|
|
|
58
61
|
setupInterceptors({
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
+
serviceIdentifier: "your-service-name",
|
|
63
|
+
serviceVersion: "1.0.0",
|
|
64
|
+
serviceAdditionalMetadata: {
|
|
62
65
|
environment: "production",
|
|
63
66
|
cluster: "east-coast",
|
|
64
67
|
},
|
|
65
68
|
domainsToNotPropagateHeadersTo: ["example.com"],
|
|
66
69
|
siteAndNodeModulesToCollectLocalVariablesOn: ["@your-org/your-package"],
|
|
67
70
|
});
|
|
68
|
-
|
|
69
71
|
```
|