search

netobserv / flowlogs-pipeline

Transform flow logs into metrics
Apache License 2.0
73 stars 23 forks source link

There are some inconsistencies in the API #206

Closed jotak closed 2 years ago

jotak commented 2 years ago

The api is not fully consistent, some names are camelCase, other lowcase and sometimes snake_case, e.g:

We should agree on a convention to follow

jotak commented 2 years ago

cc @KalmanMeth @ronensc @eranra

ronensc commented 2 years ago

I thought we had an issue for this, but I can't find it

jotak commented 2 years ago

I thought we had an issue for this, but I can't find it

Ah, maybe this: https://github.com/netobserv/flowlogs-pipeline/issues/197

ronensc commented 2 years ago

@jotak we thought to use camelCase like in k8s. WDYT? do you have any preference?

jotak commented 2 years ago

@jotak we thought to use camelCase like in k8s. WDYT? do you have any preference?

+1, it sounds more natural to me too

jotak commented 2 years ago

Summary of renamings:

prom.metrics.valuekey => prom.metrics.valueKey
prom.expirytime => prom.expiryTime
kafka.addr => kafka.address
kafka.groupbalancers => kafka.groupBalancers
kafka.startoffset => kafka.startOffset
kafka.batchreadtimeout => kafka.batchReadTimeout
grpc.buffer_length => grpc.bufferLength
network.kubeconfigpath => network.kubeConfigPath
network.servicesfile => network.servicesFile
network.protocolsfile => network.protocolsFile
aggregates.Name => aggregates.name
aggregates.By => aggregates.by
aggregates.Operation => aggregates.operation
aggregates.RecordKey => aggregates.recordKey
aggregates.TopK => aggregates.topK
jotak commented 2 years ago

closed by #213