Skip to content

Commit e9e5b04

Browse files
Juan Álvarezsimitt
authored andcommitted
Update readme (#2)
1 parent d3ee579 commit e9e5b04

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ This is the Apm-Server.
1313
+ Fork the repo with the Github interface and clone it:
1414

1515
```
16-
mkdir -p ${GOPATH}/src/github.com/elastic/apm-server
17-
cd ${GOPATH}/src/github.com/elastic/apm-server
16+
cd ${GOPATH}/src/github.com/elastic/
1817
git clone https://github.com/[USER]/apm-server
1918
```
2019
Note that it should be cloned from the fork (replace [USER] with your Github user), not from origin.
@@ -31,7 +30,6 @@ in the same directory with the name apm-server.
3130
make
3231
```
3332

34-
3533
### Run
3634

3735
To run Apm-Server with debugging output enabled, run:
@@ -40,7 +38,6 @@ To run Apm-Server with debugging output enabled, run:
4038
./apm-server -c apm-server.yml -e -d "*"
4139
```
4240

43-
4441
### Test
4542

4643
To test Apm-Server, run the following command:
@@ -51,6 +48,7 @@ make testsuite
5148

5249
alternatively:
5350
```
51+
make unit
5452
make unit-tests
5553
make system-tests
5654
make integration-tests
@@ -69,10 +67,9 @@ To generate etc/apm-server.template.json and etc/apm-server.asciidoc
6967
make update
7068
```
7169

72-
7370
### Cleanup
7471

75-
To clean Apm-Server source code, run the following commands:
72+
To clean Apm-Server source code, run the following commands:
7673

7774
```
7875
make fmt
@@ -86,7 +83,6 @@ make clean
8683

8784
For further development, check out the [beat developer guide](https://www.elastic.co/guide/en/beats/libbeat/current/new-beat.html).
8885

89-
9086
## Packaging
9187

9288
The beat frameworks provides tools to crosscompile and package your beat for different platforms. This requires [docker](https://www.docker.com/) and vendoring as described above. To build packages of your beat, run the following command:
@@ -97,7 +93,6 @@ make package
9793

9894
This will fetch and create all images required for the build process. The hole process to finish can take several minutes.
9995

100-
10196
## Update Dependencies
10297

10398
The `apm-server` has two types of dependencies:
@@ -131,3 +126,15 @@ get this running execute the following commands.
131126
* Open `localhost:5601` in your browser and log into Kibana with `elastic` and `changeme`
132127
* Create the `apm-server-*` index pattern
133128
* In Kibana go to the Discovery tab and you should see data
129+
130+
For manual testing with specific agents, check instructions at `tests/agent/[LANG]/README.md`
131+
132+
## Documentation
133+
134+
A JSON-Schema spec for the API lives in `docs/spec`.
135+
ElasticSearch fields are defined in `_meta/fields.generated.yml`.
136+
Examples of input and output documents can be found at `docs/data/intake-api` and `docs/data/elasticsearch` respectively.
137+
138+
## Help
139+
140+
`make help`

0 commit comments

Comments
 (0)