Skip to content

Commit

Permalink
Fix typo (#141)
Browse files Browse the repository at this point in the history
  • Loading branch information
hackerwins authored Jun 20, 2024
1 parent 20a191f commit 32ac729
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
6 changes: 3 additions & 3 deletions docs/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -100,11 +100,11 @@ Flags:
--mongo-connection-uri string MongoDB's connection URI
--mongo-ping-timeout duration Mongo DB's ping timeout (default 5s)
--mongo-yorkie-database string Yorkie's database name in MongoDB (default "yorkie-meta")
--profiling-port int Profiling port (default 11102)
--profiling-port int Profiling port (default 8081)
--rpc-cert-file string RPC certification file's path
--rpc-key-file string RPC key file's path
--rpc-max-requests-bytes uint Maximum client request size in bytes the server will accept. (default 4194304)
--rpc-port int RPC port (default 11101)
--rpc-port int RPC port (default 8080)
```
### Login
Expand All @@ -127,7 +127,7 @@ You can check the context of the CLI using the `context` subcommand:
$ yorkie context ls
CURRENT RPC ADDR INSECURE TOKEN
api.yorkie.dev:443 false eyJhbGciOi...DuhaUgofYg
* localhost:11101 true eyJhbGciOi...FUT3js73Mw
* localhost:8080 true eyJhbGciOi...FUT3js73Mw
```
If you want to log out from the server, you can use the `logout` subcommand:
Expand Down
22 changes: 11 additions & 11 deletions docs/self-hosted-server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ Let's start a Server with the CLI. You can start a Server with the following com
```bash
$ yorkie server
backend created: id: c6ljcdl94818baveba8g, rpc: localhost:11101: db: memory
serving RPC on 11101
serving profiling on 11102
backend created: id: cppoq5huevgut6tjo8qg, db: memory
serving RPC on 8080
serving profiling on 8081
```
The Server handles administrative requests such as project maintenance, and it continues to run until it's told to quit with termination commands such as Ctrl+C.
The Server stores its data using an in-memory DB, which does not provide durability by default.
Expand All @@ -29,17 +29,17 @@ The Server stores its data using an in-memory DB, which does not provide durabil
If you start the Server with a MongoDB address, you can permanently save the data stored by Yorkie.
> To start MongoDB, `docker-compose -f docker/docker-compose.yml up --build -d` in [the project root](https://github.com/yorkie-team/yorkie).
> To start MongoDB, `docker-compose -f build/docker/docker-compose.yml up --build -d` in [the project root](https://github.com/yorkie-team/yorkie).
Then, start a Yorkie Server with `--mongo-connection-uri` flag to connect the MongoDB.
```bash
$ yorkie server --mongo-connection-uri mongodb://localhost:27017
MongoDB connected, URI: mongodb://localhost:27017, DB: yorkie-meta
backend created: id: c6ljibt948102kkt9neg, rpc: localhost:11101: db: mongodb://localhost:27017
serving profiling on 11102
serving RPC on 11101
backend created: id: cppoqe9uevguvlsehcg0, rpc: mongodb://localhost:27017
serving profiling on 8081
serving RPC on 8080
```
### Monitoring
Expand All @@ -48,7 +48,7 @@ Server exports metrics under the `/metrics` path on its profiling port.
The metrics can be fetched with curl:
```bash
$ curl http://localhost:11102/metrics
$ curl http://localhost:8081/metrics
yorkie_server_version{server_version="{{site.version}}"} 1
# HELP yorkie_pushpull_received_changes_total The total count of changes included
Expand All @@ -61,10 +61,10 @@ This metrics can be collected from [Prometheus](https://prometheus.io/).
Running [Prometheus](https://prometheus.io/) and [Grafana](https://grafana.com/oss/grafana/) is the easiest way to monitor Server's metrics.

First, download all manifest files from [docker folder](https://github.com/yorkie-team/yorkie-team.github.io/tree/main/docker). Then, start the applications with `docker-compose`:
First, download all manifest files from [docker folder](https://github.com/yorkie-team/yorkie/tree/main/build/docker). Then, start the applications with `docker-compose`:

```bash
$ docker-compose -f docker-compose-monitoring.yml up --build -d
$ docker-compose -f docker-compose-full.yml up --build -d
Creating prometheus ... done
Creating grafana ... done
Expand All @@ -81,7 +81,7 @@ Url: http://localhost:9090
Access: proxy
```

Then, import the [default Yorkie dashboard template](https://github.com/yorkie-team/yorkie-team.github.io/tree/main/docker/yorkie-dashboard.json) and customize it. For instance, if Prometheus data source name is `my-prometheus`, the datasource field values in JSON also need to be `my-prometheus`.
Then, import the [default Yorkie dashboard template](https://grafana.com/grafana/dashboards/18560-yorkie-dashboard/) and customize it. For instance, if Prometheus data source name is `my-prometheus`, the datasource field values in JSON also need to be `my-prometheus`.

Sample dashboard:

Expand Down

0 comments on commit 32ac729

Please sign in to comment.