You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/cli/guides/configuration.md
+2-4Lines changed: 2 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,7 @@ mainFolder % dotnet beam config
42
42
}
43
43
```
44
44
45
-
However, if the `beam config` command was invoked from the `someOtherFolder` path, you should expect to see an error, because there is no `.beamable` folder within the parent lineage.
45
+
However, if the `beam config` command was invoked from the `someOtherFolder` path, you should expect to see an error, because there is no `.beamable` folder within the parent lineage.
46
46
47
47
```sh
48
48
someOtherFolder % dotnet beam config
@@ -79,9 +79,7 @@ The Beamable CLI executes as a local dotnet tool installation. That means that t
79
79
80
80
!!! info "The folder can exist in a higher folder."
81
81
82
-
Normally the `.config/` folder exists as a sibling of the `.beamable/` folder. However, the `.config/` folder _may_ exist in a parent folder. The closest `.config/` folder will be used. See the [dotnet tool documentation](https://learn.microsoft.com/en-us/dotnet/core/tools/local-tools-how-to-use) for more information.
83
-
84
-
82
+
Normally the `.config/` folder exists as a sibling of the `.beamable/` folder. However, the `.config/` folder _may_ exist in a parent folder. The closest `.config/` folder will be used. See the [dotnet tool documentation](https://learn.microsoft.com/en-us/dotnet/core/tools/local-tools-how-to-use) for more information.
Copy file name to clipboardExpand all lines: docs/cli/guides/getting-started.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ Verify it is installed by running `dotnet --version` from a terminal.
8
8
9
9
!!! info "We support Dotnet 8 as well."
10
10
11
-
If you are using the Beamable CLI before version 7.0, then you should be using [Dotnet 8](https://dotnet.microsoft.com/en-us/download/dotnet/8.0). Starting with CLI 7.0 and beyond, we support both versions of dotnet, but we recommend you use `net10.0`.
11
+
If you are using the Beamable CLI before version 7.0, then you should be using [Dotnet 8](https://dotnet.microsoft.com/en-us/download/dotnet/8.0). Starting with CLI 7.0 and beyond, we support both versions of dotnet, but we recommend you use `net10.0`.
12
12
13
13
## Installing
14
14
To install the Beamable CLI, run the following command in a shell.
Sometimes it is important to get the unescaped JSON, so the `fromjson` component of JQ can be used. For example, if we wanted the `cid` value, but without quotes,
99
+
Sometimes you need the unescaped JSON; the `fromjson` component of JQ can be used. For example, if we wanted the `cid` value, but without quotes,
Copy file name to clipboardExpand all lines: docs/cli/guides/ms-logging.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,13 +56,13 @@ Each log has a _level_, or an _importance_ rating. Logs are one of the following
56
56
-_Debug_
57
57
-_Verbose_
58
58
59
-
When you run a Microservice locally, you will see log messages at the _Debug_ level and above. However, in a deployed Microservice, you will only see **Information** and above. This is called the _Log Level_. Best practice is to avoid logging _Debug_ and _Verbose_ logs in production, as they negatively impact performance.
59
+
When you run a Microservice locally, you will see log messages at the _Debug_ level and above. However, in a deployed Microservice, you will only see **Information** and above. This is called the _Log Level_. Best practice is to avoid logging _Debug_ and _Verbose_ logs in production, as they negatively impact performance.
60
60
61
61
The `Log` type has methods for each type of log level.
62
62
63
63
!!! info
64
64
65
-
The default log level is `DEBUG` when you are running a service locally in development. However, deployed services use the `INFO` level by default.
65
+
The default log level is `DEBUG` when you are running a service locally in development. However, deployed services use the `INFO` level by default.
66
66
67
67
#### Request Dynamic Log Levels
68
68
@@ -93,7 +93,7 @@ However, the attribute, `a`, is available for querying in Portal. Use a custom s
93
93
94
94
#### Scoped Custom Attributes
95
95
96
-
It is possible to automatically add attributes to an entire sequence of logs. For example, imagine you wanted to tag a series of log lines as being part of an algorithm.
96
+
You can automatically add attributes to an entire sequence of logs. For example, imagine you wanted to tag a series of log lines as being part of an algorithm.
97
97
98
98
```csharp
99
99
[ClientCallable]
@@ -214,7 +214,7 @@ There are several standard log attributes that will be included automatically. S
214
214
215
215
### Third Party Log Hosting
216
216
217
-
Starting with version 6.0, it is possible to send Microservice logs to a third parties. In this example, we will use BetterStack.
217
+
Starting with version 6.0, you can send Microservice logs to third-party log hosting services. In this example, we will use BetterStack.
218
218
219
219
This section will assume you have set up a BetterStack account, and created a _Source_ such that you have a _source token_ and an _ingesting host_.
Copy file name to clipboardExpand all lines: docs/cli/guides/ms-routing.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,7 +73,7 @@ var scope = cid + '.' + pid;
73
73
```
74
74
#### Authorization
75
75
76
-
Finally, while not required, it is important to send an HTTP authorization header in the form of a Bearer token. The bearer token should be a valid access token for a Beamable Player. These tokens can be fetched from Portal, or you can use the following command to view the token information from a local beamable CLI project.
76
+
Finally, while not required, we recommend sending an HTTP authorization header in the form of a Bearer token. The bearer token should be a valid access token for a Beamable Player. These tokens can be fetched from the Portal, or you can use the following command to view the token information from a local beamable CLI project.
77
77
78
78
```sh
79
79
cat .beamable/temp/auth.beam.json
@@ -132,7 +132,7 @@ The automatic client code generation can be disabled when a project builds by mo
132
132
133
133
### Open API
134
134
135
-
It is possible to use the project oapi command to generate an Open API document and then use open source tools to transpile the document into a client in some other programming language.
135
+
You can use the project oapi command to generate an Open API document and then use open source tools to transpile the document into a client in some other programming language.
Copy file name to clipboardExpand all lines: docs/cli/guides/ms-workflow.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -91,7 +91,7 @@ When a service is stopped this way, you should expect to see a log in the Micros
91
91
92
92
## Observing Logs
93
93
94
-
When a service is run, the process that starts the service should receive the log outputs. For example, if the service is run through the IDE, then the IDE should receive the logs from the service. However, it is possible to attach to the logs of a running service from a separate process.
94
+
When a service is run, the process that starts the service should receive the log outputs. For example, if the service is run through the IDE, then the IDE should receive the logs from the service. However, you can attach to the logs of a running service from a separate process.
95
95
96
96
For example, imagine that a service is run through `dotnet` directly,
@@ -161,8 +161,8 @@ The upgrade from 3.0.x to 4.0.0 is relatively simple compared to other major
161
161
releases.
162
162
163
163
#### Removed `net6.0` and `net7.0` support
164
-
Unfortunately, `net6.0` and `net7.0` have reached their [End-Of-Life phases](https://devblogs.microsoft.com/dotnet/dotnet-6-end-of-support/).
165
-
The CLI 4.0 release officially drops Beamable support for these EOL .NET versions; when you update your projects, you must update your `.csproj` files to use `net8.0`.
164
+
Unfortunately, `net6.0` and `net7.0` have reached their [End-Of-Life phases](https://devblogs.microsoft.com/dotnet/dotnet-6-end-of-support/).
165
+
The CLI 4.0 release officially drops Beamable support for these EOL .NET versions; when you update your projects, you must update your `.csproj` files to use `net8.0`.
166
166
167
167
In all your `.csproj` files, find the line with the `<TargetFramework>`
0 commit comments