Skip to content

Commit

Permalink
Update usage
Browse files Browse the repository at this point in the history
  • Loading branch information
Kioubit committed Jul 17, 2024
1 parent e9c4b61 commit 408486b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 11 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,22 @@ Peering multiple nodes with a single instance of the program is also possible.
### Usage
```
Usage:
-asnPosition int
The position of the last static ASN (and for which to keep separate state for) in each path. If AddPath support has been enabled this value is '1', otherwise it is '0'. For special cases like route collectors the value may differ. (default -1)
-asn int
Your ASN number
Your ASN number
-asnPosition int
The position of the last static ASN (and for which to keep separate state for) in each path. Use of this parameter is required for special cases such as when connected to a route collector. (default -1)
-debug
Enable debug mode (produces a lot of output)
Enable debug mode (produces a lot of output)
-disableAddPath
Disable BGP AddPath support. (Setting must be replicated in BGP daemon)
Disable BGP AddPath support. (Setting must be replicated in BGP daemon)
-noPathInfo
Disable keeping path information. (Only disable if performance is a concern)
Disable keeping path information. (Only disable if performance is a concern)
-period int
Interval in seconds within which the routeChangeCounter value is evaluated (default 60)
Interval in seconds within which the routeChangeCounter value is evaluated (default 60)
-routeChangeCounter int
Number of times a route path needs to change to list a prefix
Number of times a route path needs to change to list a prefix. Use '0' to show all route changes. (default 50)
-routerID string
BGP Router ID for this program (default "0.0.0.51")
```

### Example BIRD bgp daemon configuration
Expand Down
4 changes: 2 additions & 2 deletions main.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ func main() {
fmt.Println("FlapAlerted version", Version)
monitor.SetVersion(Version)

routeChangeCounter := flag.Int("routeChangeCounter", 0, "Number of times a route path needs to change to list a prefix")
routeChangeCounter := flag.Int("routeChangeCounter", 50, "Number of times a route path needs to change to list a prefix. Use '0' to show all route changes.")
flapPeriod := flag.Int("period", 60, "Interval in seconds within which the routeChangeCounter value is evaluated")
asn := flag.Int("asn", 0, "Your ASN number")
routerID := flag.String("routerID", "0.0.0.51", "BGP Router ID for this program")
noPathInfo := flag.Bool("noPathInfo", false, "Disable keeping path information. (Only disable if performance is a concern)")
disableAddPath := flag.Bool("disableAddPath", false, "Disable BGP AddPath support. (Setting must be replicated in BGP daemon)")
relevantAsnPosition := flag.Int("asnPosition", -1, "The position of the last static ASN (and for which to keep separate state for)"+
" in each path. Use of this parameter is required for special cases like for instance when connected to a route collector.")
" in each path. Use of this parameter is required for special cases such as when connected to a route collector.")
enableDebug := flag.Bool("debug", false, "Enable debug mode (produces a lot of output)")

flag.Parse()
Expand Down

0 comments on commit 408486b

Please sign in to comment.