remove todos, add license

LICENSE

@@ -1 +1,201 @@
-#TODO license compatible with prometheus license
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [2023] [Martin Ptacek]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

client/app/src/main/java/com/birdthedeveloper/prometheus/android/exporter/compose/HomeActivity.kt

@@ -411,7 +411,6 @@ private fun ConfigFileSuccessPage(
     val uiState: PromUiState by promViewModel.uiState.collectAsState()
 
     Column {
-        //TODO implement this
         Text("Config file success:", modifier = Modifier.padding(vertical = 20.dp))
         Text(uiState.promConfig.toStructuredText())
     }

client/app/src/main/java/com/birdthedeveloper/prometheus/android/exporter/compose/SettingsActivity.kt

@@ -77,6 +77,7 @@ fun LicensePage(
             }
         )
         Text(
+            //TODO license
             modifier = Modifier.padding(all = 8.dp),
             text = "License todo"
         )

client/app/src/main/java/com/birdthedeveloper/prometheus/android/exporter/worker/PromWorker.kt

@@ -46,7 +46,6 @@ class PromWorker(
         ExemplarConfig.disableExemplars() // prometheus client library configuration
     }
 
-    //TODO foreground notification
     private val notificationManager =
         context.getSystemService(Context.NOTIFICATION_SERVICE) as
                 NotificationManager
@@ -110,7 +109,7 @@ class PromWorker(
                             getContext = {context}
                         )
                     )
-                    Log.d(TAG, "PushProx launching now") //TODO is singleThreadContext a problem??
+                    Log.d(TAG, "PushProx launching now")
                     launch {
                         Log.d(TAG, "PushProx launched")
                         pushProxClient.start()

client/app/src/main/java/com/birdthedeveloper/prometheus/android/exporter/worker/RemoteWriteSenderDbStorage.kt

@@ -1,129 +0,0 @@
-// Author: Martin Ptacek
-
-package com.birdthedeveloper.prometheus.android.exporter.worker
-
-//import android.content.Context
-//import androidx.annotation.EmptySuper
-//import androidx.room.Dao
-//import androidx.room.Database
-//import androidx.room.Embedded
-//import androidx.room.Entity
-//import androidx.room.PrimaryKey
-//import androidx.room.Query
-//import androidx.room.Room
-//import androidx.room.RoomDatabase
-//import kotlinx.serialization.Serializable
-//import kotlinx.serialization.json.Json
-//import remote.write.RemoteWrite.TimeSeries
-//
-///// Room is a relational database
-/////     Contains the following tables:
-/////     - TimeSeries table:
-/////         + labels : List<TimeSeriesLabel> sorted alphabetically and encoded in json
-/////     - Sample table:
-/////         + id
-/////         + timestamp
-/////         + value
-/////         + TimeSeries foreign key
-//
-//@Entity
-//data class RoomTimeSeries (
-//    @PrimaryKey(autoGenerate = false)
-//    val labels : String
-//)
-//
-//@Entity
-//data class RoomSample(
-//    @PrimaryKey(autoGenerate = true)
-//    val id: Int = 0,
-//    val timeStamp : Long,
-//    val value : Double,
-//)
-//
-//@Serializable
-//data class TimeSeriesLabelList(
-//    val labels: List<TimeSeriesLabel>
-//)
-//
-//data class TimeSeriesWithSamples(
-//    @Embedded val timeSeries: RoomTimeSeries,
-//    @Embedded val sample : RoomSample,
-//)
-//
-//@Database(
-//    entities = [RoomTimeSeries::class, RoomSample::class],
-//    version = 1
-//)
-//abstract class RemoteWriteDatabase: RoomDatabase() {
-//    abstract val dao: RoomDao
-//}
-//
-//@Dao
-//interface RoomDao {
-//
-//    fun insertOneTimeSeriesSample(){
-//
-//    }
-//    @Query("")//TODO
-//    private fun insertTimeSeries(){
-//
-//    }
-//
-//    @Query("")///TODO
-//    private fun insertSamples(){
-//
-//    }
-//
-//    //@Query("SELECT * ") //TODO
-//    fun getNumberOfTimeSeriesSamples(number : Int) : List<TimeSeriesWithSamples>
-//
-//    @Query("") //TODO
-//    fun getTotalNumberOfSamples(){
-//
-//    }
-//
-//}
-//
-//class RemoteWriteSenderDbStorage(getContext: () -> Context) : RemoteWriteSenderStorage(){
-//    companion object{
-//        const val dbName = "prometheus.db"
-//    }
-//
-//    private val roomDb by lazy {
-//        Room.databaseBuilder(
-//            getContext(),
-//            RemoteWriteDatabase::class.java,
-//            dbName,
-//        ).build()
-//    }
-//
-//    private fun encodeLabels(labelsList: List<TimeSeriesLabel>) : String{
-//        /// preserve the same order
-//        val sorted : List<TimeSeriesLabel> = labelsList.sortedBy { it.name }
-//        val timeSeriesLabelList = TimeSeriesLabelList(labels = sorted)
-//        return Json.encodeToString(TimeSeriesLabelList.serializer(), timeSeriesLabelList)
-//    }
-//
-//    private fun decodeLabels(labels : String) : List<TimeSeriesLabel> {
-//        return Json.decodeFromString<TimeSeriesLabelList>(labels).labels
-//    }
-//    override fun writeScrapedSample(metricsScrape: MetricsScrape) {
-//        TODO("Not yet implemented")
-//    }
-//
-//    override fun getScrapedSamplesCompressedProtobuf(howMany: Int): ByteArray {
-//        TODO("Not yet implemented")
-//    }
-//
-//    override fun removeNumberOfScrapedSamples(number: Int) {
-//        TODO("Not yet implemented")
-//    }
-//
-//    override fun isEmpty(): Boolean {
-//        TODO("Not yet implemented")
-//    }
-//
-//    override fun getLength(): Int {
-//        TODO("Not yet implemented")
-//    }
-//}

client/app/src/main/java/com/birdthedeveloper/prometheus/android/exporter/worker/RemoteWriteSenderMemStorage.kt

@@ -125,7 +125,6 @@ class RemoteWriteSenderSimpleMemoryStorage : RemoteWriteSenderStorage() {
         }
     }
 
-    //TODO use this thing
     override fun removeNumberOfScrapedSamples(number: Int) {
         if (number > 0) {
             for (i in 1..number) {

config_file_structure.yaml

@@ -1,31 +1,32 @@
 # Author: Martin Ptacek
 
-# This is a configuration file example for prometheus android exporter.
+# This is a configuration file example for Prometheu Android Exporter.
 
-#TODO format this thing
+# Settings specific to exporting metrics using a HTTP server (Prometheus exporter mode)
-
-# Settings specific to exporting metrics using a HTTP server
 prometheus_server:
 
   enabled: true # default
   port: 10101 # default
 
-# Settings specific to pushing metrics to pushprox proxy
+# Settings specific to pushing metrics to PushProx proxy server
 # This is handy for traversing network topologies such as NAT
 pushprox:
 
   enabled: false # default
+
   # fully qualified domain name
-  # example: com.example.test
+  # example: test.example.com
   fqdn: # string, no default value provided
 
+  # example: http://example.com:8080
   proxy_url: # string, no default value provided
 
-# Settings specific to backfilling metrics using prometheus remote write
+# Settings for the batch exporter mode
+# specific to backfilling metrics using prometheus remote write
 # 
 # Please note that remote_write may be limited by a receiving backend on 
 # how old the backfilled time series can be.
-# For prometheus this limit is set to 1 hour
+# For prometheus this limit is set to roughly 1 hour
 remote_write:
 
   # scrape interval in seconds
@@ -37,7 +38,11 @@ remote_write:
   # example: http://localhost:9090/
   remote_write_endpoint:
 
-  # default value is 500 scrapes 
+  max_samples_per_export: 500 # default
-  max_samples_per_export: 500
 
   export_interval: 60 # default
+
+  # instance and job target labels, no defaults are provided
+  # string values
+  instance:
+  job: 

local/remote_receive/docker-compose.yaml

@@ -7,7 +7,7 @@ services:
     container_name: prometheus_remote_receive
     image: bitnami/prometheus:2.43.0
     restart: on-failure
-    command: --config.file=/etc/prometheus/prometheus.yml --enable-feature=remote-write-receiver #TODO
+    command: --config.file=/etc/prometheus/prometheus.yml --enable-feature=remote-write-receiver
     volumes:
       - ./prometheus.yaml:/etc/prometheus/prometheus.yml
     ports:

server/configuration/prometheus.yaml

@@ -14,7 +14,7 @@ scrape_configs:
 
   
   - job_name: "android phones"
-    proxy_url: "http://pushprox:8080" #TODO add mobile phones here
+    proxy_url: "http://pushprox:8080"
     tls_config:
       insecure_skip_verify: true
     static_configs: